cache

Documentation

Index

• type Cache
• type Driver
• type Lock

Types

type Cache

type Cache interface {
	Driver
	Store(name string) Driver
}

type Driver

type Driver interface {
	//Add Driver an item in the cache if the key does not exist.
	Add(key string, value any, t time.Duration) bool
	Decrement(key string, value ...int) (int, error)
	//Forever Driver an item in the cache indefinitely.
	Forever(key string, value any) bool
	//Forget Remove an item from the cache.
	Forget(key string) bool
	//Flush Remove all items from the cache.
	Flush() bool
	//Get Retrieve an item from the cache by key.
	Get(key string, def ...any) any
	GetBool(key string, def ...bool) bool
	GetInt(key string, def ...int) int
	GetInt64(key string, def ...int64) int64
	GetString(key string, def ...string) string
	//Has Check an item exists in the cache.
	Has(key string) bool
	Increment(key string, value ...int) (int, error)
	Lock(key string, t ...time.Duration) Lock
	//Put Driver an item in the cache for a given time.
	Put(key string, value any, t time.Duration) error
	//Pull Retrieve an item from the cache and delete it.
	Pull(key string, def ...any) any
	//Remember Get an item from the cache, or execute the given Closure and store the result.
	Remember(key string, ttl time.Duration, callback func() any) (any, error)
	//RememberForever Get an item from the cache, or execute the given Closure and store the result forever.
	RememberForever(key string, callback func() any) (any, error)
	WithContext(ctx context.Context) Driver
}

type Lock

type Lock interface {
	Block(t time.Duration, callback ...func()) bool
	Get(callback ...func()) bool
	Release() bool
	ForceRelease() bool
}