memory

Documentation

Index

• func NewAdapter(opts ...AdapterOptions) (cache.Adapter, error)
• type Adapter
  • func (a *Adapter) Get(key uint64) ([]byte, bool)
  • func (a *Adapter) Release(key uint64)
  • func (a *Adapter) Set(key uint64, response []byte, expiration time.Time)
• type AdapterOptions
  • func AdapterWithAlgorithm(alg Algorithm) AdapterOptions
  • func AdapterWithCapacity(cap int) AdapterOptions
• type Algorithm

Functions

func NewAdapter

func NewAdapter(opts ...AdapterOptions) (cache.Adapter, error)

NewAdapter initializes memory adapter.

Types

type Adapter

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

Adapter is the memory adapter data structure.

func (*Adapter) Get

func (a *Adapter) Get(key uint64) ([]byte, bool)

Get implements the cache Adapter interface Get method.

func (*Adapter) Release

func (a *Adapter) Release(key uint64)

Release implements the Adapter interface Release method.

func (*Adapter) Set

func (a *Adapter) Set(key uint64, response []byte, expiration time.Time)

Set implements the cache Adapter interface Set method.

type AdapterOptions

type AdapterOptions func(a *Adapter) error

AdapterOptions is used to set Adapter settings.

func AdapterWithAlgorithm

func AdapterWithAlgorithm(alg Algorithm) AdapterOptions

AdapterWithAlgorithm sets the approach used to select a cached response to be evicted when the capacity is reached.

func AdapterWithCapacity

func AdapterWithCapacity(cap int) AdapterOptions

AdapterWithCapacity sets the maximum number of cached responses.

type Algorithm

type Algorithm string

Algorithm is the string type for caching algorithms labels.

const (
	// LRU is the constant for Least Recently Used.
	LRU Algorithm = "LRU"

	// MRU is the constant for Most Recently Used.
	MRU Algorithm = "MRU"

	// LFU is the constant for Least Frequently Used.
	LFU Algorithm = "LFU"

	// MFU is the constant for Most Frequently Used.
	MFU Algorithm = "MFU"
)