arc

Documentation

Index

• type ARC
  • func New[K comparable, V any](options ...Option[K, V]) *ARC[K, V]
  • func (a *ARC[K, V]) Clear()
  • func (a *ARC[K, V]) Get(key K) (value V, ok bool)
  • func (a *ARC[K, V]) GetWithExpire(key K) (V, time.Time, bool)
  • func (a *ARC[K, V]) Len() int
  • func (a *ARC[K, V]) Set(key K, value V)
  • func (a *ARC[K, V]) SetWithExpire(key K, value V, expires time.Time)
• type Option
  • func WithSize[K comparable, V any](maxSize int) Option[K, V]

Types

type ARC

type ARC[K comparable, V any] struct {
	// contains filtered or unexported fields
}

func New

func New[K comparable, V any](options ...Option[K, V]) *ARC[K, V]

New returns a new Adaptive Replacement Cache (ARC).

func (*ARC[K, V]) Clear

func (a *ARC[K, V]) Clear()

func (*ARC[K, V]) Get

func (a *ARC[K, V]) Get(key K) (value V, ok bool)

Get retrieves a previously via Set inserted entry. This optimizes future access to this entry (side effect).

func (*ARC[K, V]) GetWithExpire

func (a *ARC[K, V]) GetWithExpire(key K) (V, time.Time, bool)

GetWithExpire returns any representation of a cached response, a time.Time Give expected expires, and a bool set to true if the key was found. This method will NOT update the expires.

func (*ARC[K, V]) Len

func (a *ARC[K, V]) Len() int

Len determines the number of currently cached entries. This method is side-effect free in the sense that it does not attempt to optimize random cache access.

func (*ARC[K, V]) Set

func (a *ARC[K, V]) Set(key K, value V)

Set inserts a new key-value pair into the cache. This optimizes future access to this entry (side effect).

func (*ARC[K, V]) SetWithExpire

func (a *ARC[K, V]) SetWithExpire(key K, value V, expires time.Time)

SetWithExpire stores any representation of a response for a given key and given expires. The expires time will round to second.

type Option

type Option[K comparable, V any] func(*ARC[K, V])

Option is part of Functional Options Pattern

func WithSize

func WithSize[K comparable, V any](maxSize int) Option[K, V]