Polyjuice Client v0.4.4 Polyjuice.Client.Storage protocol View Source

Persistent storage for the Matrix client

Link to this section Summary

Types

t()

value()

Safe values to use for key-value storage. All storage must support at least these types.

Functions

Close the storage.

get_filter_id(storage, filter)

Get the ID stored for a filter, or nil if no ID has been stored.

get_sync_token(storage)

Get the latest sync token, or nil if no sync token has been set.

kv_del(storage, namespace, key)

Delete the data for a specific key.

kv_get(storage, namespace, key, default \\ nil)

Get the data for a specific key.

kv_put(storage, namespace, key, value)

Store data for a specific key.

set_filter_id(storage, filter, filter_id)

Store the ID for a filter.

set_sync_token(storage, token)

Set the sync token.

Link to this section Types

t()

t() :: term()

value()

value() ::
  true
  | false
  | nil
  | String.t()
  | float()
  | [value(), ...]
  | %{optional(String.t()) => value()}

Safe values to use for key-value storage. All storage must support at least these types.

Link to this section Functions

close(storage)

close(storage :: t()) :: any()

Close the storage.

get_filter_id(storage, filter)

get_filter_id(storage :: t(), filter :: map()) :: String.t() | nil

Get the ID stored for a filter, or nil if no ID has been stored.

get_sync_token(storage)

get_sync_token(storage :: t()) :: String.t() | nil

Get the latest sync token, or nil if no sync token has been set.

kv_del(storage, namespace, key)

kv_del(t(), String.t(), String.t()) :: any()

Delete the data for a specific key.

kv_get(storage, namespace, key, default \\ nil)

kv_get(t(), String.t(), String.t(), value()) :: value()

Get the data for a specific key.

kv_put(storage, namespace, key, value)

kv_put(t(), String.t(), String.t(), value()) :: any()

Store data for a specific key.

set_filter_id(storage, filter, filter_id)

set_filter_id(storage :: t(), filter :: map(), filter_id :: String.t()) ::
  any()

Store the ID for a filter.

set_sync_token(storage, token)

set_sync_token(storage :: t(), token :: String.t()) :: any()

Set the sync token.