View Source Nebulex.Entry (Nebulex v2.6.4)

Defines a Cache Entry.

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

Summary

Types

t()

Defines a generic struct for a cache entry.

Functions

decode(data, opts \\ [])

Decodes a previously encoded entry.

encode(data, opts \\ [])

Encodes a cache entry.

expired?(entry)

Returns whether the given entry has expired or not.

ttl(entry)

Returns the remaining time-to-live.

Types

t()

@type 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.

Functions

decode(data, opts \\ [])

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

Decodes a previously encoded entry.

Example

iex> "hello"
...> |> Nebulex.Entry.encode()
...> |> Nebulex.Entry.decode()
"hello"

encode(data, opts \\ [])

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

Encodes a cache entry.

Example

iex> "hello"
...> |> Nebulex.Entry.encode()
...> |> Nebulex.Entry.decode()
"hello"

expired?(entry)

@spec expired?(t()) :: boolean()

Returns whether the given entry has expired or not.

Example

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

iex> Nebulex.Entry.expired?(
...>   %Nebulex.Entry{touched: Nebulex.Time.now() - 10, ttl: 1}
...> )
true

ttl(entry)

@spec ttl(t()) :: timeout()

Returns the remaining time-to-live.

Example

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

iex> ttl =
...>   Nebulex.Entry.ttl(
...>     %Nebulex.Entry{touched: Nebulex.Time.now(), ttl: 100}
...>   )
iex> ttl > 0
true