Crux

v2020-03-17 17:55:51Z

Crux v2020-03-17 17:55:51Z Crux.Cache.User View Source

Default Crux.Structs.User cache.

Difference opposed to "regular" base caches.

  • Has me/0, me!/0 and me/1 functions to specify or retrieve the own user.

Link to this section Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

delete(id)

Deletes data from the cache by key.

fetch(id)

Fetches data from the cache by key.

fetch!(id)

Fetches data from the cache by key, raises if not found.

insert(data)

Inserts data into the cache.

me()

Fetches the own user.

me(id)

Sets the id of the own user, the data itself has to be inserted into the cache like usual.

me!()

Fetches the own user, raises if not cached.

start_link(args \\ [])

Used to start anything fitting under a supervision tree, like for example a GenServer, instructed with handling the cache.

update(data)

Inserts data into the cache.

Link to this section Functions

Link to this function

child_spec(init_arg) View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

delete(id) View Source 
delete(id :: Crux.Cache.key()) :: :ok

Deletes data from the cache by key.

Callback implementation for Crux.Cache.delete/1.

Link to this function

fetch(id) View Source 
fetch(id :: Crux.Cache.key()) :: {:ok, term()} | :error

Fetches data from the cache by key.

Callback implementation for Crux.Cache.fetch/1.

Link to this function

fetch!(id) View Source 
fetch!(id :: identifier()) :: {:ok, term()} | :error

Fetches data from the cache by key, raises if not found.

Callback implementation for Crux.Cache.fetch!/1.

Link to this function

insert(data) View Source 
insert(data :: term()) :: term()

Inserts data into the cache.

Returns the atomified data allowing the operation to be chained.

For example something like that:

id =
  raw_data
  |> Cache.insert()
  |> Map.get(:id)

Callback implementation for Crux.Cache.insert/1.

Link to this function

me() View Source 
me() :: {:ok, Crux.Structs.User.t()} | :error

Fetches the own user.

Link to this function

me(id) View Source 
me(id :: integer()) :: integer()

Sets the id of the own user, the data itself has to be inserted into the cache like usual.

Link to this function

me!() View Source 
me!() :: Crux.Structs.User.t() | no_return()

Fetches the own user, raises if not cached.

Link to this function

start_link(args \\ []) View Source 
start_link(args :: term()) :: GenServer.on_start()

Used to start anything fitting under a supervision tree, like for example a GenServer, instructed with handling the cache.

Optional, you maybe want to use external caching, e.g. Redis, not requiring anything like that.

Callback implementation for Crux.Cache.start_link/1.

Link to this function

update(data) View Source 
update(data :: term()) :: term()

Inserts data into the cache.

Returns "updated" data including changes by merging.
For example from a message embed update to a full message object

content =
  partial_message # only contains `:id`, `:channel_id`, and `:embeds`
  |> Cache.update()
  |> Map.get(:content) # present if the message was cached previously

Callback implementation for Crux.Cache.update/1.