Skema.Result (Skema v1.0.1)

View Source

Result Struct for Skema operations

Summary

Functions

Get error from result for given field.

Create a new Result struct with given schema map and params.

Put valid data to result.

Put error to result.

Functions

get_error(result, field)

@spec get_error(
  %Skema.Result{
    errors: term(),
    params: term(),
    schema: term(),
    valid?: term(),
    valid_data: term()
  },
  field :: atom()
) :: String.t() | nil

Get error from result for given field.

new(attrs)

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

Create a new Result struct with given schema map and params.

put_data(result, field, value)

@spec put_data(
  %Skema.Result{
    errors: term(),
    params: term(),
    schema: term(),
    valid?: term(),
    valid_data: term()
  },
  field :: atom(),
  value :: any()
) :: %Skema.Result{
  errors: term(),
  params: term(),
  schema: term(),
  valid?: term(),
  valid_data: term()
}

Put valid data to result.

put_error(result, field, error)

@spec put_error(
  %Skema.Result{
    errors: term(),
    params: term(),
    schema: term(),
    valid?: term(),
    valid_data: term()
  },
  field :: atom(),
  error :: String.t()
) :: %Skema.Result{
  errors: term(),
  params: term(),
  schema: term(),
  valid?: term(),
  valid_data: term()
}

Put error to result.