CarCache.Cache (CarCache v0.1.1) View Source

Data structure representing an CAR cache.

Link to this section Summary

Types

t()

Functions

delete(car, key)

Mark a key as deleted.

get(car, key)

Get an item from the cache

new(name, opts \\ [])

Create a new Cache data structure

put(car, key, value)

Insert an item in the cache

Link to this section Types

t()

Specs

t() :: %CarCache.Cache{
  b1: CarCache.LRU.t(),
  b2: CarCache.LRU.t(),
  c: non_neg_integer(),
  data: :ets.tid(),
  name: atom(),
  p: non_neg_integer(),
  t1: CarCache.Clock.t(),
  t2: CarCache.Clock.t()
}

Link to this section Functions

delete(car, key)

Specs

delete(t(), any()) :: t()

Mark a key as deleted.

It will not be returned on a get and will be eventually evicted from the cache as more keys are inserted.

get(car, key)

Specs

get(t() | atom(), any()) :: any()

Get an item from the cache

new(name, opts \\ [])

Create a new Cache data structure

put(car, key, value)

Specs

put(t(), any(), any()) :: t()

Insert an item in the cache