Nebulex v1.2.2 Nebulex.Object View Source

Defines a Cache Object.

This is the struct used by the caches to store and retrieve data.

Link to this section Summary

t()

Returns the UNIX timestamp in seconds for the given ttl.

Returns whether the given object has expired or not.

Returns the remaining time to live for the given timestamp.

t() :: %Nebulex.Object{
  expire_at: integer() | nil,
  key: any(),
  value: any(),
  version: any()
}

expire_at(ttl :: timeout() | nil) :: integer() | nil

Returns the UNIX timestamp in seconds for the given ttl.

iex> expire_at = Nebulex.Object.expire_at(10)
iex> expire_at - Nebulex.Object.ts()
10

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

Returns whether the given object has expired or not.

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

remaining_ttl(object_or_ttl :: t() | integer() | nil) :: timeout()

Returns the remaining time to live for the given timestamp.

iex> expire_at = Nebulex.Object.expire_at(10)
iex> Nebulex.Object.remaining_ttl(expire_at)
10

ts(datetime :: Calendar.datetime()) :: integer()

iex> 1_464_096_368 |> DateTime.from_unix!() |> Nebulex.Object.ts()
1464096368