cachefunk

package module

Go to main page

Versions in this module

v0

v0.4.2

Sep 4, 2025

Changes in this version

+ var ErrDoNotCache = errors.New("do not cache the entry")

v0.4.1

Aug 28, 2025

Changes in this version

+ func CacheWithIgnore[Params any, ResultType any](cache *CacheFunk, key string, ...) (ResultType, error)

+ func GetIgnoreCacheFromContext(ctx context.Context) bool

+ func SetIgnoreCacheInContext(ctx context.Context, value bool) context.Context

+ func WrapWithIgnore[Params any, ResultType any](cache *CacheFunk, key string, ...) func(bool, Params) (ResultType, error)

type CacheFunk

+ func (c *CacheFunk) GetLazy(key string, config *KeyConfig, params string) (LazyLoad, error)

type KeyConfig

+ func (kc *KeyConfig) DecompressAndUnmarshal(valueData []byte, value any) error

+ func (kc *KeyConfig) MarshalAndCompress(value any) ([]byte, error)

+ type LazyLoad func(any) error

v0.4.0

May 27, 2025

Changes in this version

+ const TTLEntryImmediatelyExpires

+ const TTLEntryNeverExpires

+ var BrotliCompression = &brotliCompression

+ var DefaultBodyCodec = JSONCodec

+ var DefaultBodyCompression = ZstdCompression

+ var DefaultDiskStoragePather = SHA256HexPather

+ var DefaultKeyConfig = &KeyConfig

+ var DefaultParamCodec = JSONParams

+ var ErrEntryExpired = errors.New("cache entry expired")

+ var ErrEntryNotFound = errors.New("cache entry not found")

+ var GzipCompression = &gzipCompression

+ var JSONBase64Params = &jsonBase64Params

+ var JSONCodec = &jsonCodec

+ var JSONParams = &jsonParams

+ var MaxDate = time.Date(9999, 1, 1, 0, 0, 0, 0, time.UTC)

+ var MinDate = time.Date(1970, 1, 1, 0, 0, 0, 0, time.UTC)

+ var MsgPackCodec = &msgpackCodec

+ var NoCompression = &noCompression

+ var StringCodec = &stringCodec

+ var TTLMax = int64(MaxDate.Sub(MinDate) / time.Second)

+ var ZstdCompression = &zstdCompression

+ func CacheWithContext[Params any, ResultType any](cache *CacheFunk, key string, ...) (ResultType, error)

+ func DisableWarnings()

+ func EnableWarnings()

+ func SHA256Base64Pather(key string, params string) []string

+ func SHA256HexPather(key string, params string) []string

+ func SetWarningLog(logger *log.Logger)

+ type BodyCodec interface

+ Marshal func(v any) ([]byte, error)

+ String func() string

+ Unmarshal func(data []byte, v any) error

type CacheEntry

+ CompressionType string

+ type CacheFunk struct

+ Config *Config

+ IgnoreCtxKey CtxKey

+ Storage CacheStorage

+ func (c *CacheFunk) Cleanup()

+ func (c *CacheFunk) Clear() error

+ func (c *CacheFunk) EntryCount() (int64, error)

+ func (c *CacheFunk) ExpiredEntryCount() (int64, error)

+ func (c *CacheFunk) Get(key string, config *KeyConfig, params string, ignoreExpireTime bool, value any) error

+ func (c *CacheFunk) GetIgnoreCtxKey() CtxKey

+ func (c *CacheFunk) Set(key string, config *KeyConfig, params string, value any) error

+ type CacheStorage interface

+ Cleanup func(key string, config *KeyConfig, expireTime time.Time) error

+ Clear func() error

+ Dump func(n int64)

+ EntryCount func() (count int64, err error)

+ ExpiredEntryCount func(key string, config *KeyConfig, expireTime time.Time) (count int64, err error)

+ Get func(key string, config *KeyConfig, params string, expireTime time.Time) (value []byte, err error)

+ Set func(key string, config *KeyConfig, params string, value []byte, ...) (err error)

+ type Compression interface

+ Compress func(input []byte) ([]byte, error)

+ CompressAndWrite func(w io.Writer, data []byte) error

+ Decompress func(input []byte) ([]byte, error)

+ ReadAndDecompress func(r io.Reader) ([]byte, error)

+ String func() string

type Config

+ Configs map[string]*KeyConfig

+ Defaults *KeyConfig

+ func (c *Config) Get(key string) *KeyConfig

type CtxKey

+ const DefaultIgnoreCacheCtxKey

+ type DiskStorage struct

+ BasePath string

+ CalculatePath DiskStoragePather

+ func NewDiskStorage(basePath string, pather DiskStoragePather) *DiskStorage

+ func (c *DiskStorage) Cleanup(key string, config *KeyConfig, expireTime time.Time) error

+ func (c *DiskStorage) Clear() error

+ func (c *DiskStorage) Dump(n int64)

+ func (c *DiskStorage) EntryCount() (int64, error)

+ func (c *DiskStorage) ExpiredEntryCount(key string, config *KeyConfig, expireTime time.Time) (int64, error)

+ func (c *DiskStorage) Get(key string, config *KeyConfig, params string, expireTime time.Time) ([]byte, error)

+ func (c *DiskStorage) IterateFiles(basePath string, callback func(string, fs.DirEntry))

+ func (c *DiskStorage) Set(key string, config *KeyConfig, params string, value []byte, ...) error

+ type DiskStoragePather func(key string, params string) []string

+ type GORMStorage struct

+ DB *gorm.DB

+ func NewGORMStorage(db *gorm.DB) (*GORMStorage, error)

+ func (c *GORMStorage) Cleanup(key string, config *KeyConfig, expireTime time.Time) error

+ func (c *GORMStorage) Clear() error

+ func (c *GORMStorage) Dump(n int64)

+ func (c *GORMStorage) EntryCount() (int64, error)

+ func (c *GORMStorage) ExpiredEntryCount(key string, config *KeyConfig, expireTime time.Time) (int64, error)

+ func (c *GORMStorage) Get(key string, config *KeyConfig, params string, expireTime time.Time) ([]byte, error)

+ func (c *GORMStorage) Set(key string, config *KeyConfig, params string, value []byte, ...) error

+ type InMemoryStorage struct

+ func NewInMemoryStorage() *InMemoryStorage

+ func (c *InMemoryStorage) Cleanup(key string, config *KeyConfig, expireTime time.Time) error

+ func (c *InMemoryStorage) Clear() error

+ func (c *InMemoryStorage) Dump(n int64)

+ func (c *InMemoryStorage) EntryCount() (int64, error)

+ func (c *InMemoryStorage) ExpiredEntryCount(key string, config *KeyConfig, expireTime time.Time) (int64, error)

+ func (c *InMemoryStorage) Get(key string, config *KeyConfig, params string, expireTime time.Time) ([]byte, error)

+ func (c *InMemoryStorage) Set(key string, config *KeyConfig, params string, value []byte, ...) error

+ type InMemoryStorageEntry struct

+ CompressionType string

+ Data []byte

+ Timestamp time.Time

type KeyConfig

+ BodyCodec BodyCodec

+ BodyCompression Compression

+ FallbackToExpired bool

+ ParamCodec ParamCodec

+ func (kc *KeyConfig) GetBodyCodec() BodyCodec

+ func (kc *KeyConfig) GetBodyCompression() Compression

+ func (kc *KeyConfig) GetExpireTime(now time.Time) time.Time

+ func (kc *KeyConfig) GetParamCodec() ParamCodec

+ func (kc *KeyConfig) GetTimestamp(now time.Time) time.Time

+ func (kc *KeyConfig) MarshalJSON() ([]byte, error)

+ func (kc *KeyConfig) UnmarshalJSON(data []byte) error

+ type ParamCodec interface

+ Marshal func(v any) (string, error)

+ String func() string

+ Unmarshal func(data string, v any) error

+ type ParameterEncoder func(interface{}) (string, error)

v0.3.2

Aug 24, 2023

v0.3.1

Aug 24, 2023

retracted

v0.3.0

Aug 24, 2023

retracted

v0.2.0

Feb 23, 2023

retracted

Changes in this version

+ func WrapWithContext(retrieveFunc func(context.Context, Params) (ResultType, error), cache Cache, ...) func(context.Context, Params) (ResultType, error)

v0.1.0

Feb 7, 2023

retracted

Changes in this version

+ func Wrap(retrieveFunc func(bool, Params) (ResultType, error), cache Cache, ...) func(bool, Params) (ResultType, error)

type CacheEntry

+ CreatedAt time.Time

+ ExpiresAt *time.Time

+ type Config struct

+ Key string

+ TTL int64

+ TTLJitter int64

type InMemoryCacheEntry

+ ExpiresAt *time.Time

v0.0.1

Aug 24, 2023

retracted

Changes in this version

+ var DEFAULT_KEYCONFIG = &KeyConfig

+ func CacheObject(cache Cache, key string, retrieveFunc func(bool, Params) (ResultType, error), ...) (ResultType, error)

+ func CacheObjectWithContext(cache Cache, key string, ...) (ResultType, error)

+ func CacheString(cache Cache, key string, retrieveFunc func(bool, Params) (ResultType, error), ...) (ResultType, error)

+ func CacheStringWithContext(cache Cache, key string, ...) (ResultType, error)

+ func DefaultCalculatePath(cacheKey string, params string) []string

+ func RenderParameters(params interface{}) (string, error)

+ func WrapObject(cache Cache, key string, retrieveFunc func(bool, Params) (ResultType, error)) func(bool, Params) (ResultType, error)

+ func WrapObjectWithContext(cache Cache, key string, ...) func(context.Context, Params) (ResultType, error)

+ func WrapString(cache Cache, key string, retrieveFunc func(bool, Params) (ResultType, error)) func(bool, Params) (ResultType, error)

+ func WrapStringWithContext(cache Cache, key string, ...) func(context.Context, Params) (ResultType, error)

+ type Cache interface

+ Cleanup func()

+ Clear func()

+ EntryCount func() int64

+ ExpiredEntryCount func() int64

+ Get func(key string, params string) (value []byte, found bool)

+ GetIgnoreCacheCtxKey func() CtxKey

+ Set func(key string, params string, value []byte)

+ SetConfig func(config *CacheFunkConfig)

+ SetRaw func(key string, params string, value []byte, timestamp time.Time, ...)

+ type CacheEntry struct

+ Data []byte

+ ID int64

+ IsCompressed bool

+ Key string

+ Params string

+ Timestamp time.Time

+ type CacheFunkConfig struct

+ Configs map[string]*KeyConfig

+ Defaults *KeyConfig

+ func (c *CacheFunkConfig) Get(key string) *KeyConfig

+ type CtxKey string

+ const DEFAULT_IGNORE_CACHE_CTX_KEY

+ type DiskCache struct

+ BasePath string

+ CacheConfig *CacheFunkConfig

+ CalculatePath func(cacheKey string, params string) []string

+ IgnoreCacheCtxKey CtxKey

+ func NewDiskCache(basePath string, calcPathFn ...func(string, string) []string) *DiskCache

+ func (c *DiskCache) Cleanup()

+ func (c *DiskCache) Clear()

+ func (c *DiskCache) EntryCount() int64

+ func (c *DiskCache) ExpiredEntryCount() int64

+ func (c *DiskCache) Get(key string, params string) ([]byte, bool)

+ func (c *DiskCache) GetIgnoreCacheCtxKey() CtxKey

+ func (c *DiskCache) IterateFiles(basePath string, callback func(string, fs.DirEntry))

+ func (c *DiskCache) Set(key string, params string, value []byte)

+ func (c *DiskCache) SetConfig(config *CacheFunkConfig)

+ func (c *DiskCache) SetRaw(key string, params string, value []byte, timestamp time.Time, ...)

+ type GORMCache struct

+ CacheConfig *CacheFunkConfig

+ DB *gorm.DB

+ IgnoreCacheCtxKey CtxKey

+ func NewGORMCache(db *gorm.DB) *GORMCache

+ func (c *GORMCache) Cleanup()

+ func (c *GORMCache) Clear()

+ func (c *GORMCache) EntryCount() int64

+ func (c *GORMCache) ExpiredEntryCount() int64

+ func (c *GORMCache) Get(key string, params string) ([]byte, bool)

+ func (c *GORMCache) GetIgnoreCacheCtxKey() CtxKey

+ func (c *GORMCache) Set(key string, params string, value []byte)

+ func (c *GORMCache) SetConfig(config *CacheFunkConfig)

+ func (c *GORMCache) SetRaw(key string, params string, value []byte, timestamp time.Time, ...)

+ type InMemoryCache struct

+ CacheConfig *CacheFunkConfig

+ IgnoreCacheCtxKey CtxKey

+ Store map[string]*InMemoryCacheEntry

+ func NewInMemoryCache() *InMemoryCache

+ func (c *InMemoryCache) Cleanup()

+ func (c *InMemoryCache) Clear()

+ func (c *InMemoryCache) EntryCount() int64

+ func (c *InMemoryCache) ExpiredEntryCount() int64

+ func (c *InMemoryCache) Get(key string, params string) ([]byte, bool)

+ func (c *InMemoryCache) GetIgnoreCacheCtxKey() CtxKey

+ func (c *InMemoryCache) Set(key string, params string, value []byte)

+ func (c *InMemoryCache) SetConfig(config *CacheFunkConfig)

+ func (c *InMemoryCache) SetRaw(key string, params string, value []byte, timestamp time.Time, ...)

+ type InMemoryCacheEntry struct

+ Data string

+ IsCompressed bool

+ Timestamp time.Time

+ type KeyConfig struct

+ TTL int64

+ TTLJitter int64

+ UseCompression bool

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL