memorycache

Documentation

Index

• type CacheOption
• type CacheValue
• type KvCache
  • func NewKvCache(opts ...kvcachehelper.CacheOptions) *KvCache
  • func (c *KvCache) Get(ctx context.Context, key string) (string, bool)
  • func (c *KvCache) Remove(ctx context.Context, key string) bool
  • func (c *KvCache) Set(ctx context.Context, key string, value string)

Types

type CacheOption

type CacheOption map[string]interface{}

type CacheValue

type CacheValue struct {
	// The cache's expiration time
	ExpirationTime time.Time
	// The cache's value
	Value string
}

type KvCache

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

func NewKvCache

func NewKvCache(opts ...kvcachehelper.CacheOptions) *KvCache

NewKvCache instantiates a new Cache and sets the default values. The default expiration time is set to 6 hours from the current time. The expiration time can be overridden by passing an expirationTime option. Example: cache := NewKvCache(ExpirationTime: time.Now().Add(1 * time.Hour))

func (*KvCache) Get

func (c *KvCache) Get(ctx context.Context, key string) (string, bool)

Get retrieves a value from the cache. If the key does not exist or the value has expired, it will return false.

func (*KvCache) Remove

func (c *KvCache) Remove(ctx context.Context, key string) bool

Remove removes a key-value pair from the cache.

func (*KvCache) Set

func (c *KvCache) Set(ctx context.Context, key string, value string)

Set adds a new key-value pair to the cache. If the key already exists, it will be overwritten.