@spec cast(module(), map()) :: {:ok, struct()} | {:error, reason :: term()}

Cast incoming data based on a Shape definition.

@spec cast!(module(), map()) :: struct()

Cast incoming data based on a Shape definition. Raises on error.

@spec cast_all(module(), [map()]) :: {:ok, [struct()]} | {:error, reason :: term()}

Cast a list of maps to a list of Shapes.

@spec cast_all!(module(), [map()]) :: [struct()]

Cast a list of maps to a list of Shapes.

Define a field within a shape.

@spec is_shape?(module()) :: boolean()

Determine whether the given module represents a shape.

Define a shape schema. Generates a struct definition for the current module that includes the data needed to correctly cast incoming JSON/map data into that struct, including field sourcing, type conversions, etc.

Define a shape schema. Generates a struct definition for the current module that includes the data needed to correctly cast incoming JSON/map data into that struct, including field sourcing, type conversions, etc.

Options

• :transform - A function that accepts the generated shape struct and performs any transformations required. Called after a successful cast.