tyyppi
tyyppi v0.12.3

View Source Tyyppi.Example.Nested (tyyppi v0.12.3)

Example of the nested structure defined with Tyyppi.Struct.defstruct/1

The code of this module follows.

use Tyyppi

@defaults date_time: Value.date_time("1973-09-30 02:30:00Z"),
          struct: %Tyyppi.Example.Value{}
defstruct date_time: Value.t(DateTime.t()),
          struct: Tyyppi.Example.Value.t()

Link to this section Summary

Types

t()

The type describing Tyyppi.Example.Nested. This type will be used to validate upserts when called via Access and/or Tyyppi.Struct.put/3, Tyyppi.Struct.update/3, both delegating to generated Tyyppi.Example.Nested.update/2.

Functions

as_value(values \\ [])

Factory for Elixir.Tyyppi.Example.Nested wrapped by Tyyppi.Value

errors(s)
flatten(struct)

See Tyyppi.Struct.flatten/1.

flatten(struct, opts)

See Tyyppi.Struct.flatten/2.

is_value(value)

Helper guard to match instances of struct Tyyppi.Value

types()

Returns the field types of this struct as keyword of {field :: atom, type :: Tyyppi.T.t(term())} pairs.

update(target, values)

Updates the struct

valid?(s)
validate(s)

This function is supposed to be overwritten in the implementation in cases when custom validation is required.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Tyyppi.Example.Nested{
  date_time: Tyyppi.Value.t(DateTime.t()),
  struct: Tyyppi.Example.Value.t()
}

The type describing Tyyppi.Example.Nested. This type will be used to validate upserts when called via Access and/or Tyyppi.Struct.put/3, Tyyppi.Struct.update/3, both delegating to generated Tyyppi.Example.Nested.update/2.

Upon insertion, the value will be coerced to the expected type when available, the type itself will be validated, and then the custom validation will be applied when applicable.

Link to this section Functions

Link to this function

as_value(values \\ [])

View Source 
@spec as_value(keyword()) :: Tyyppi.Value.t({:any, [], []})

Factory for Elixir.Tyyppi.Example.Nested wrapped by Tyyppi.Value

Link to this function

errors(s)

View Source 
@spec errors(t()) :: list()
Link to this function

flatten(struct)

View Source

See Tyyppi.Struct.flatten/1.

Link to this function

flatten(struct, opts)

View Source

See Tyyppi.Struct.flatten/2.

Link to this macro

is_value(value)

View Source (since 0.9.0) (macro)

Helper guard to match instances of struct Tyyppi.Value

Link to this function

types()

View Source 
@spec types() :: [{atom(), Tyyppi.T.t(wrapped)}] when wrapped: term()

Returns the field types of this struct as keyword of {field :: atom, type :: Tyyppi.T.t(term())} pairs.

Link to this function

update(target, values)

View Source 
@spec update(target :: t(), values :: keyword()) :: {:ok, t()} | {:error, keyword()}

Updates the struct

Link to this function

valid?(s)

View Source 
@spec valid?(t()) :: boolean()
Link to this function

validate(s)

View Source 
@spec validate(t()) :: Tyyppi.Valuable.either()

This function is supposed to be overwritten in the implementation in cases when custom validation is required.

It would be called after all casts and type validations, if the succeeded