View Source DetsPlus.LRU (DetsPlus v2.4.3)

DetsPlus.LRU Least-Recently-Used cache based on DetsPlus persistent storage.

Example:

alias DetsPlus.LRU

{:ok, dets} = DetsPlus.open_file(:example)
filter = fn value -> value != nil end
max_size = 2
lru = LRU.new(dets, max_size, filter)
LRU.put(lru, 1, "1")
LRU.put(lru, 2, "2")
LRU.put(lru, 3, "3")
LRU.get(lru, 1) == nil

DetsPlus.close(dets)

Summary

Functions

delete(lru, key)

Deletes a value from the cache.

fetch(lru, key, fun)

Fetches a value from the cache, or calculates it if it's not found.

fetch_nolock(lru, key, fun)

Fetches a value from the cache, or calculates it if it's not found.

filter(lru)

Returns the filter function of the cache.

flush(lru)

Flushes the cache deleting all objects.

get(lru, key, default \\ nil)

Gets a value from the cache.

max_size(lru)

Returns the maximum size of the cache.

new(dets, max_size, filter \\ fn _ -> true end)

Creates a new LRU cache.

put(lru, key, value)

Puts a value in the cache.

size(lru)

Returns the size of the cache.

to_list(lru)

Returns the keys and values of the cache.

update(lru, key, fun)

Updates a value in the cache.

Functions

delete(lru, key)

Deletes a value from the cache.

Parameters

lru - The LRU cache.
key - The key to delete.

fetch(lru, key, fun)

Fetches a value from the cache, or calculates it if it's not found.

Parameters

lru - The LRU cache.
key - The key to fetch the value for.
fun - The function to calculate the value if it's not found.

fetch_nolock(lru, key, fun)

Fetches a value from the cache, or calculates it if it's not found.

Same as fetch/3, but without locking.

Parameters

lru - The LRU cache.
key - The key to fetch the value for.
fun - The function to calculate the value if it's not found.

filter(lru)

Returns the filter function of the cache.

Parameters

lru - The LRU cache.

flush(lru)

Flushes the cache deleting all objects.

Parameters

lru - The LRU cache.

get(lru, key, default \\ nil)

Gets a value from the cache.

Parameters

lru - The LRU cache.
key - The key to get the value for.
default - The default value to return if the key is not found.

max_size(lru)

Returns the maximum size of the cache.

Parameters

lru - The LRU cache.

new(dets, max_size, filter \\ fn _ -> true end)

Creates a new LRU cache.

Parameters

dets - The DetsPlus storage to use.
max_size - The maximum number of items to store.
filter - A filter function that determines if a value should be stored or not.

put(lru, key, value)

Puts a value in the cache.

Parameters

lru - The LRU cache.
key - The key to store the value under.
value - The value to store.

size(lru)

Returns the size of the cache.

Parameters

lru - The LRU cache.

to_list(lru)

Returns the keys and values of the cache.

Parameters

lru - The LRU cache.

update(lru, key, fun)

Updates a value in the cache.

Parameters

lru - The LRU cache.
key - The key to update.
fun - The function to calculate the new value.