cache

Documentation

Index

• type ExpireTime
• type FileCache
  • func NewFileCache(path string) (*FileCache, error)
  • func (c *FileCache) Close() error
  • func (c *FileCache) Get(key string) (Value, bool)
  • func (c *FileCache) Remove(key string)
  • func (c *FileCache) Set(key string, value Value, expireTime ExpireTime)
• type Item
• type Value
  • func NewValue(v any) (Value, error)
  • func (c Value) Unmarshal(v any) error

Types

type ExpireTime

type ExpireTime int64

ExpireTime in UnixNano

const (
	NeverExpired ExpireTime = -1
)

type FileCache

type FileCache struct {
	// contains filtered or unexported fields
}

FileCache is a cache that saves to a file

func NewFileCache

func NewFileCache(path string) (*FileCache, error)

NewFileCache creates a new FileCache

func (*FileCache) Close

func (c *FileCache) Close() error

Close the cache and save to file

func (*FileCache) Get

func (c *FileCache) Get(key string) (Value, bool)

Get a value by key

func (*FileCache) Remove

func (c *FileCache) Remove(key string)

Remove a key from the cache

func (*FileCache) Set

func (c *FileCache) Set(key string, value Value, expireTime ExpireTime)

Set a key value pair with a duration

type Item

type Item struct {
	Val    []byte
	Expire int64 // Expire time in UnixNano, -1 means never expire
}

Item is a cache item

type Value

type Value []byte

Value CacheValue is a byte slice that can be unmarshaled into any type

func NewValue

func NewValue(v any) (Value, error)

NewValue marshals the given value into a CacheValue

func (Value) Unmarshal

func (c Value) Unmarshal(v any) error

Unmarshal the CacheValue into the given value