Skema.Caster (Skema v1.5.0)

Handles type casting logic for Skema schemas.

This module is responsible for converting raw input data to proper types according to schema definitions. It processes each field, applies custom casting functions, and handles nested schemas and arrays.

Summary

Functions

cast_field(data, field_name, definitions)

Casts a single field value according to its definition.

process_cast_and_validate(result)

Processes casting and validation for all fields in a schema in a single pass.

process_casting(result)

Processes casting for all fields in a schema.

process_field(result, arg)

Processes casting for a single field.

process_field_with_validation(result, arg)

Processes casting and validation for a single field.

Functions

cast_field(data, field_name, definitions)

@spec cast_field(map(), atom(), keyword()) :: {:ok, any()} | {:error, any()}

Casts a single field value according to its definition.

process_cast_and_validate(result)

@spec process_cast_and_validate(%Skema.Result{
  errors: term(),
  params: term(),
  schema: term(),
  valid?: term(),
  valid_data: term()
}) ::
  {:ok, map()}
  | {:error,
     %Skema.Result{
       errors: term(),
       params: term(),
       schema: term(),
       valid?: term(),
       valid_data: term()
     }}

Processes casting and validation for all fields in a schema in a single pass.

This is an optimized version that validates each field immediately after successful casting, reducing the number of iterations from 2 to 1.

Returns {:ok, data} if both casting and validation succeed, {:error, result} otherwise.

process_casting(result)

@spec process_casting(%Skema.Result{
  errors: term(),
  params: term(),
  schema: term(),
  valid?: term(),
  valid_data: term()
}) ::
  {:ok, map()}
  | {:error,
     %Skema.Result{
       errors: term(),
       params: term(),
       schema: term(),
       valid?: term(),
       valid_data: term()
     }}

Processes casting for all fields in a schema.

Returns {:ok, data} if casting succeeds, {:error, result} otherwise.

process_field(result, arg)

@spec process_field(
  %Skema.Result{
    errors: term(),
    params: term(),
    schema: term(),
    valid?: term(),
    valid_data: term()
  },
  {atom(), list()}
) :: %Skema.Result{
  errors: term(),
  params: term(),
  schema: term(),
  valid?: term(),
  valid_data: term()
}

Processes casting for a single field.

process_field_with_validation(result, arg)

@spec process_field_with_validation(
  %Skema.Result{
    errors: term(),
    params: term(),
    schema: term(),
    valid?: term(),
    valid_data: term()
  },
  {atom(), list()}
) :: %Skema.Result{
  errors: term(),
  params: term(),
  schema: term(),
  valid?: term(),
  valid_data: term()
}

Processes casting and validation for a single field.

Casts the field first, and if successful, immediately validates it.