kvasir v0.0.18

View Source Kvasir.Type behaviour (kvasir v0.0.18)

Link to this section Summary

Types

base()
t()

Callbacks

describe(value)
doc()

Type documentation.

dump(value)
dump(value, opts)
name()

Type descriptive name.

obfuscate(value)
obfuscate(value, opts)
parse(value)
parse(value, opts)

Functions

lookup(type)

Lookup a base type.

Link to this section Types

Link to this type

base()

View Source 
@type base() ::
  atom()
  | boolean()
  | integer()
  | String.t()
  | [base()]
  | %{optional(base()) => base()}
Link to this type

t()

View Source 
@type t() :: atom()

Link to this section Callbacks

Link to this callback

describe(value)

View Source 
@callback describe(value :: term()) :: String.t()
Link to this callback

doc()

View Source 
@callback doc() :: String.t()

Type documentation.

Link to this callback

dump(value)

View Source 
@callback dump(value :: term()) :: {:ok, term()} | {:error, atom()}
Link to this callback

dump(value, opts)

View Source 
@callback dump(value :: term(), opts :: Keyword.t()) :: {:ok, term()} | {:error, atom()}
Link to this callback

name()

View Source 
@callback name() :: String.t()

Type descriptive name.

Link to this callback

obfuscate(value)

View Source 
@callback obfuscate(value :: term()) :: {:ok, term()} | :obfuscate | {:error, atom()}
Link to this callback

obfuscate(value, opts)

View Source 
@callback obfuscate(value :: term(), opts :: Keyword.t()) ::
  {:ok, term()} | :obfuscate | {:error, atom()}
Link to this callback

parse(value)

View Source 
@callback parse(value :: any()) :: {:ok, term()} | {:error, atom()}
Link to this callback

parse(value, opts)

View Source 
@callback parse(value :: any(), opts :: Keyword.t()) :: {:ok, term()} | {:error, atom()}

Link to this section Functions

Link to this function

lookup(type)

View Source 
@spec lookup(atom()) :: atom()

Lookup a base type.