Estructura.Nested.Type behaviour (estructura v1.11.0)

The type to be used for coercing, validating, and generation of the implementation’s instances.

Summary

coerce(term)

Coerces the value coming from outside

generate()

The generator for the type

generate(opts)

The generator for the type accepting options

The generator for the type accepting options

produce(keyword)

The producer for the type accepting options (differs from generate/1 being a non-shrinkable usually infinite stream)

validate(term)

Validates the value as being correct

@callback coerce(term()) :: {:ok, term()} | {:error, any()}

Coerces the value coming from outside

@callback generate() :: StreamData.t(any())

The generator for the type

@callback generate(opts :: keyword()) :: StreamData.t(any())

The generator for the type accepting options

@callback generate(opts :: keyword(), payload :: any()) :: StreamData.t(any())

The generator for the type accepting options

(optional)

@callback produce(keyword()) :: Enumerable.t()

The producer for the type accepting options (differs from generate/1 being a non-shrinkable usually infinite stream)

@callback validate(term()) :: {:ok, term()} | {:error, any()}

Validates the value as being correct