View Source Tyyppi.Value (tyyppi v0.12.3)

Value type to be used with Tyyppi.

It wraps the standard Elixir type in a struct, also providing optional coercion, validation, documentation, and Access implementation.

built-in-constructors
Built-in constructors

any
atom
string
boolean
integer
non_neg_integer
pos_integer
timeout
pid
mfa
mod_arg
fun
one_of
formulae
list — creates a [type()] wrapped into a value
struct

Link to this section Summary

Types

coercer()

Type of the coercion function allowed

encoder()

Type of the encoder function, that might be used for e. g. Json serialization

factory_option()

generator()

Type of the generator function, producing the stream of value()

t()

t(wrapped)

validator()

Type of the validation function allowed

Functions

any()

Creates a not defined any() wrapped by Tyyppi.Value

any(options)

Factory for any() wrapped by Tyyppi.Value

atom()

Creates a not defined atom() wrapped by Tyyppi.Value

atom(options)

Factory for atom() wrapped by Tyyppi.Value

boolean()

Creates a not defined boolean() wrapped by Tyyppi.Value

boolean(options)

Factory for boolean() wrapped by Tyyppi.Value

date()

Creates a not defined date() wrapped by Tyyppi.Value

date(options)

Factory for date() wrapped by Tyyppi.Value

date_time()

Creates a not defined date_time() wrapped by Tyyppi.Value

date_time(options)

Factory for date_time() wrapped by Tyyppi.Value

float()

Creates a not defined float() wrapped by Tyyppi.Value

float(options)

Factory for float() wrapped by Tyyppi.Value

formulae()

Creates a not defined formulae wrapped by Tyyppi.Value

formulae(formulae)

formulae(value, formulae)

Factory for formulae wrapped by Tyyppi.Value

fun(arity \\ :any)

Creates a not defined fun wrapped by Tyyppi.Value

integer()

Creates a not defined integer() wrapped by Tyyppi.Value

integer(options)

Factory for integer() wrapped by Tyyppi.Value

is_formulae(value)

Helper guard to match instances of struct Formulae

list()

Creates a not defined list wrapped by Tyyppi.Value

list(type)

Factory for list wrapped by Tyyppi.Value

list(value, type)

mfa()

Creates a not defined mfa wrapped by Tyyppi.Value

mfa(existing)

Factory for mfa wrapped by Tyyppi.Value

mfa(m, f, a)

Factory for mfa wrapped by Tyyppi.Value

mod_arg()

Creates a not defined mod_arg wrapped by Tyyppi.Value

mod_arg(existing)

Factory for mod_arg wrapped by Tyyppi.Value

mod_arg(m, args)

Factory for mod_arg wrapped by Tyyppi.Value

non_neg_integer()

Creates a not defined non_neg_integer() wrapped by Tyyppi.Value

non_neg_integer(options)

Factory for non_neg_integer() wrapped by Tyyppi.Value

one_of(options)

Creates a one_of value wrapped by Tyyppi.Value

one_of(value, allowed)

optional(value)

pid()

Creates a not defined pid() wrapped by Tyyppi.Value

pid(options)

Factory for pid() wrapped by Tyyppi.Value

pid(p1, p2, p3)

Factory for pid() wrapped by Tyyppi.Value

pos_integer()

Creates a not defined pos_integer() wrapped by Tyyppi.Value

pos_integer(options)

Factory for pos_integer() wrapped by Tyyppi.Value

string()

Creates a not defined String.t() wrapped by Tyyppi.Value

string(options)

Factory for String.t() wrapped by Tyyppi.Value

struct()

Creates a not defined struct wrapped by Tyyppi.Value

struct(options)

Factory for struct wrapped by Tyyppi.Value

timeout()

Creates a not defined timeout() wrapped by Tyyppi.Value

timeout(options)

Factory for timeout() wrapped by Tyyppi.Value

validate(data, value)

Link to this section Types

coercer()

@type coercer() :: (Tyyppi.Valuable.value() -> Tyyppi.Valuable.either())

Type of the coercion function allowed

encoder()

@type encoder() :: (Tyyppi.Valuable.value(), keyword() -> binary()) | nil

Type of the encoder function, that might be used for e. g. Json serialization

factory_option()

@type factory_option() ::
  {:value, any()}
  | {:documentation, String.t()}
  | {:type, Tyyppi.T.t(term())}
  | {:coercion, coercer()}
  | {:validation, validator()}
  | {:encoding, encoder()}
  | {:generation, {generator(), any()} | generator() | nil}

generator()

@type generator() ::
  (() -> Tyyppi.Valuable.generation()) | (any() -> Tyyppi.Valuable.generation())

Type of the generator function, producing the stream of value()

t()

@type t() :: t(term())

t(wrapped)

@type t(wrapped) :: %Tyyppi.Value{
  value: Tyyppi.Valuable.value(),
  documentation: String.t(),
  type: Tyyppi.T.t(wrapped),
  coercion: coercer(),
  validation: validator(),
  encoding: encoder(),
  generation: {generator(), any()} | generator() | nil,
  __meta__: %{
    defined?: boolean(),
    optional?: boolean(),
    errors: [any()],
    subsection: String.t()
  },
  __context__: %{optional(atom()) => any()}
}

validator()

@type validator() ::
  (Tyyppi.Valuable.value() -> Tyyppi.Valuable.either())
  | (Tyyppi.Valuable.value(), %{required(atom()) => any()} ->
       Tyyppi.Valuable.either())

Type of the validation function allowed

Link to this section Functions

any()

@spec any() :: t()

Creates a not defined any() wrapped by Tyyppi.Value

any(options)

@spec any(any() | [factory_option()]) :: t()

Factory for any() wrapped by Tyyppi.Value

atom()

@spec atom() :: t()

Creates a not defined atom() wrapped by Tyyppi.Value

atom(options)

@spec atom(options :: any() | [factory_option()]) :: t()

Factory for atom() wrapped by Tyyppi.Value

boolean()

@spec boolean() :: t()

Creates a not defined boolean() wrapped by Tyyppi.Value

boolean(options)

@spec boolean(options :: any() | [factory_option()]) :: t()

Factory for boolean() wrapped by Tyyppi.Value

date()

@spec date() :: t()

Creates a not defined date() wrapped by Tyyppi.Value

date(options)

@spec date(options :: any() | [factory_option()]) :: t()

Factory for date() wrapped by Tyyppi.Value

date_time()

@spec date_time() :: t()

Creates a not defined date_time() wrapped by Tyyppi.Value

date_time(options)

@spec date_time(options :: any() | [factory_option()]) :: t()

Factory for date_time() wrapped by Tyyppi.Value

float()

@spec float() :: t()

Creates a not defined float() wrapped by Tyyppi.Value

float(options)

@spec float(options :: any() | [factory_option()]) :: t()

Factory for float() wrapped by Tyyppi.Value

formulae()

@spec formulae() :: t()

Creates a not defined formulae wrapped by Tyyppi.Value

formulae(formulae)

@spec formulae(
  options :: Formulae.t() | binary() | [{:formulae, any()} | factory_option()]
) :: t()

formulae(value, formulae)

@spec formulae(
  value :: any(),
  formulae :: Formulae.t() | binary() | {module(), atom(), list()}
) :: t()

Factory for formulae wrapped by Tyyppi.Value

fun(arity \\ :any)

@spec fun(:any | arity() | keyword() | (... -> any())) :: t() | no_return()

Creates a not defined fun wrapped by Tyyppi.Value

integer()

@spec integer() :: t()

Creates a not defined integer() wrapped by Tyyppi.Value

integer(options)

@spec integer(options :: any() | [factory_option()]) :: t()

Factory for integer() wrapped by Tyyppi.Value

is_formulae(value)

(since 0.9.0) (macro)

Helper guard to match instances of struct Formulae

list()

@spec list() :: t()

Creates a not defined list wrapped by Tyyppi.Value

list(type)

@spec list(
  options ::
    Tyyppi.T.t(wrapped) | [{:type, Tyyppi.T.t(wrapped)} | factory_option()]
) ::
  t(wrapped)
when wrapped: term()

Factory for list wrapped by Tyyppi.Value

list(value, type)

@spec list(value :: list(), type :: Tyyppi.T.t(wrapped)) :: t(wrapped)
when wrapped: term()

mfa()

@spec mfa() :: t()

Creates a not defined mfa wrapped by Tyyppi.Value

mfa(existing)

@spec mfa(
  options ::
    boolean()
    | function()
    | {module(), atom(), non_neg_integer()}
    | [{:existing, boolean()} | factory_option()]
) :: t()

Factory for mfa wrapped by Tyyppi.Value

mfa(m, f, a)

@spec mfa(m :: module(), f :: atom(), a :: non_neg_integer()) :: t()

Factory for mfa wrapped by Tyyppi.Value

mod_arg()

@spec mod_arg() :: t()

Creates a not defined mod_arg wrapped by Tyyppi.Value

mod_arg(existing)

@spec mod_arg(
  options ::
    boolean() | {module(), list()} | [{:existing, boolean()} | factory_option()]
) ::
  t()

Factory for mod_arg wrapped by Tyyppi.Value

mod_arg(m, args)

@spec mod_arg(m :: module(), args :: list()) :: t()

Factory for mod_arg wrapped by Tyyppi.Value

non_neg_integer()

@spec non_neg_integer() :: t()

Creates a not defined non_neg_integer() wrapped by Tyyppi.Value

non_neg_integer(options)

@spec non_neg_integer(options :: any() | [factory_option()]) :: t()

Factory for non_neg_integer() wrapped by Tyyppi.Value

one_of(options)

@spec one_of([any()]) :: t()

Creates a one_of value wrapped by Tyyppi.Value

one_of(value, allowed)

@spec one_of(any(), [any()]) :: t()

optional(value)

@spec optional(t(wrapped)) :: t(wrapped) when wrapped: term()

pid()

@spec pid() :: t()

Creates a not defined pid() wrapped by Tyyppi.Value

pid(options)

@spec pid(options :: any() | [factory_option()]) :: t()

Factory for pid() wrapped by Tyyppi.Value

pid(p1, p2, p3)

@spec pid(p1 :: non_neg_integer(), p2 :: non_neg_integer(), p3 :: non_neg_integer()) ::
  t()

Factory for pid() wrapped by Tyyppi.Value

pos_integer()

@spec pos_integer() :: t()

Creates a not defined pos_integer() wrapped by Tyyppi.Value

pos_integer(options)

@spec pos_integer(options :: any() | [factory_option()]) :: t()

Factory for pos_integer() wrapped by Tyyppi.Value

string()

@spec string() :: t()

Creates a not defined String.t() wrapped by Tyyppi.Value

string(options)

@spec string(options :: any() | [factory_option()]) :: t()

Factory for String.t() wrapped by Tyyppi.Value

struct()

@spec struct() :: t()

Creates a not defined struct wrapped by Tyyppi.Value

struct(options)

@spec struct(options :: [factory_option()]) :: t()

@spec struct(value :: struct()) :: t()

Factory for struct wrapped by Tyyppi.Value

timeout()

@spec timeout() :: t()

Creates a not defined timeout() wrapped by Tyyppi.Value

timeout(options)

@spec timeout(options :: any() | [factory_option()]) :: t()

Factory for timeout() wrapped by Tyyppi.Value

validate(data, value)

@spec validate(data :: t(), any()) :: Tyyppi.Valuable.either()

Settings View Source Tyyppi.Value (tyyppi v0.12.3)

built-in-constructors Built-in constructors

Link to this section Summary

Types

Functions

Link to this section Types

coercer()

encoder()

factory_option()

generator()

t()

t(wrapped)

validator()

Link to this section Functions

any()

any(options)

atom()

atom(options)

boolean()

boolean(options)

date()

date(options)

date_time()

date_time(options)

float()

float(options)

formulae()

formulae(formulae)

formulae(value, formulae)

fun(arity \\ :any)

integer()

integer(options)

is_formulae(value)

list()

list(type)

list(value, type)

mfa()

mfa(existing)

mfa(m, f, a)

mod_arg()

mod_arg(existing)

mod_arg(m, args)

non_neg_integer()

non_neg_integer(options)

one_of(options)

one_of(value, allowed)

optional(value)

pid()

pid(options)

pid(p1, p2, p3)

pos_integer()

pos_integer(options)

string()

string(options)

struct()

struct(options)

timeout()

timeout(options)

validate(data, value)

View Source Tyyppi.Value (tyyppi v0.12.3)

built-in-constructors
Built-in constructors