Kvasir.Key behaviour (kvasir v0.0.15) View Source

Link to this section Summary

Link to this section Callbacks

Specs

describe(value :: term()) :: String.t()

Specs

doc() :: String.t()

Key documentation.

Specs

dump(value :: term()) :: {:ok, term()} | {:error, atom()}

Specs

dump(value :: term(), opts :: Keyword.t()) :: {:ok, term()} | {:error, atom()}

Specs

name() :: String.t()

Key descriptive name.

Specs

obfuscate(value :: term()) :: {:ok, term()} | :obfuscate | {:error, atom()}

Specs

obfuscate(value :: term(), opts :: Keyword.t()) ::
  {:ok, term()} | :obfuscate | {:error, atom()}

Specs

parse(value :: any()) :: {:ok, term()} | {:error, atom()}

Specs

parse(value :: any(), opts :: Keyword.t()) :: {:ok, term()} | {:error, atom()}
Link to this callback

partition(value, partitions)

View Source

Specs

partition(value :: term(), partitions :: pos_integer()) ::
  {:ok, non_neg_integer()} | {:error, atom()}