Nebulex.Entry (Nebulex v2.0.0) View Source

Defines a Cache Entry.

This is the structure used by the caches for representing cache entries.

Link to this section Summary

t()

Defines a generic struct for a cache entry.

Decodes a previously encoded entry.

Encodes a cache entry.

Returns whether the given entry has expired or not.

Returns the remaining time-to-live.

t() :: %Nebulex.Entry{
  key: any(),
  time_unit: System.time_unit(),
  touched: integer(),
  ttl: timeout(),
  value: any()
}

Defines a generic struct for a cache entry.

The entry depends on the adapter completely, this struct/type aims to define the common fields.

decode(binary(), [term()]) :: term()

Decodes a previously encoded entry.

iex> %Nebulex.Entry{}
...> |> Nebulex.Entry.encode()
...> |> Nebulex.Entry.decode()
_decoded_entry

encode(term(), [term()]) :: binary()

Encodes a cache entry.

iex> Nebulex.Entry.encode(%Nebulex.Entry{})
_encoded_entry

expired?(t()) :: boolean()

Returns whether the given entry has expired or not.

iex> Nebulex.Entry.expired?(%Nebulex.Entry{})
false

ttl(t()) :: timeout()

Returns the remaining time-to-live.

iex> Nebulex.Entry.ttl(%Nebulex.Entry{})
:infinity