tyyppi
tyyppi v0.12.3

View Source Tyyppi.Valuable behaviour (tyyppi v0.12.3)

The behaviour all participants of the Tyyppi’s operations should have implemented.

It’s implemented by Tyyppi.Value and Tyyppi.Struct, making them available for deep nested validations, coercion and generation.

Link to this section Summary

Types

either()

Type returned from coercions and validations, typical pair of ok/error tuples, involving the value() as a main type behind

generation()

Type of the generation function, basically returning a stream of generated values

value()

Type of the value behind the implementation

Callbacks

coerce(value)

The coercion function, receiving the value()

flatten(value, keyword)

Flattens the struct using the options passed

generation(value)

The generation function, returning the generator for the whole

validate(value)

The validation function, receiving the value()

Link to this section Types

Link to this type

either()

View Source 
@type either() :: {:ok, value()} | {:error, any()}

Type returned from coercions and validations, typical pair of ok/error tuples, involving the value() as a main type behind

Link to this type

generation()

View Source 
@type generation() :: StreamData.t(value())

Type of the generation function, basically returning a stream of generated values

Link to this type

value()

View Source 
@type value() :: any()

Type of the value behind the implementation

Link to this section Callbacks

Link to this callback

coerce(value)

View Source 
@callback coerce(value()) :: either()

The coercion function, receiving the value()

Link to this callback

flatten(value, keyword)

View Source 
@callback flatten(
  value(),
  keyword()
) :: value()

Flattens the struct using the options passed

Link to this callback

generation(value)

View Source 
@callback generation(value()) :: generation()

The generation function, returning the generator for the whole

Link to this callback

validate(value)

View Source 
@callback validate(value()) :: either()

The validation function, receiving the value()