filecache

README

Go FileCache

Simple file-based cache.

Usage

package main

import "gitlab.com/kukymbrgo/filecache"

func main()  {
	
    // Initialize cache
    c, err := filecache.New("/path/to/cache/dir", "")
    if err != nil {
    	panic(err)
    } 
    
    // ... make some reader
}

Documentation

Index

• Constants
• type FileCache
  • func New(path string, namespaceDefault string) (*FileCache, error)
  • func (c *FileCache) ItemPath(key string, namespace string, relative bool) (string, error)
  • func (c *FileCache) Key(key string) string
  • func (c *FileCache) Reader(key string, namespace string) (io.Reader, error)
  • func (c *FileCache) WriteFromReader(key string, source io.Reader, namespace string) error

Constants

const NamespaceDefault = "dft"

Default namespace

Types

type FileCache

type FileCache struct {

	// Path to the cache files directory
	Path string

	// Default namespace if left empty in functions params
	NamespaceDefault string
}

Cache

func New

func New(path string, namespaceDefault string) (*FileCache, error)

Create file cache instance

func (*FileCache) ItemPath

func (c *FileCache) ItemPath(key string, namespace string, relative bool) (string, error)

Get Key path

func (*FileCache) Key

func (c *FileCache) Key(key string) string

Get hex-encoded Key hash string

func (*FileCache) Reader

func (c *FileCache) Reader(key string, namespace string) (io.Reader, error)

Get cache item reader

func (*FileCache) WriteFromReader

func (c *FileCache) WriteFromReader(key string, source io.Reader, namespace string) error

Write data from reader to the cache item