Packages
zoi
0.6.0
0.18.6
0.18.5
0.18.4
0.18.3
0.18.2
0.18.1
0.18.0
0.17.4
0.17.3
0.17.2
0.17.1
0.17.0
0.16.1
0.16.0
0.15.0
0.14.1
0.14.0
0.13.1
0.13.0
0.12.1
0.12.0
0.11.1
0.11.0
0.10.7
0.10.6
0.10.5
0.10.4
0.10.3
0.10.2
0.10.1
0.10.0
0.9.1
0.9.0
0.9.0-rc.1
0.9.0-rc.0
0.8.4
0.8.3
0.8.2
0.8.1
0.8.0
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.6
0.6.5
0.6.4
0.6.3
0.6.2
0.6.1
0.6.0
0.5.7
0.5.6
0.5.5
0.5.4
0.5.3
0.5.2
0.5.1
0.5.0
0.4.0
0.3.4
0.3.3
0.3.2
0.3.1
0.3.0
0.2.3
0.2.2
0.2.1
0.2.0
0.1.3
0.1.2
0.1.1
0.1.0
Zoi is a schema validation library for Elixir, designed to provide a simple and flexible way to define and validate data.
Current section
Files
Jump to
Current section
Files
lib/zoi/context.ex
defmodule Zoi.Context do
@moduledoc """
The Context provides the parsing information such as the input data, parsed data and errors.
The context is passed around during the parsing process to keep track of the current state of parsing.
It contains the schema being parsed, the input data, the parsed data, the path of the current error and any errors that have occurred during parsing.
"""
@type t :: %__MODULE__{
schema: Zoi.Type.t(),
input: Zoi.input(),
parsed: Zoi.input(),
path: Zoi.Error.path(),
errors: list(Zoi.Error.t())
}
@type error :: Zoi.Error.t() | binary() | list(Zoi.Error.t())
defstruct [:schema, :input, :parsed, :path, :errors]
@doc false
@spec new(Zoi.Type.t(), Zoi.input()) :: t()
def new(schema, input) do
%__MODULE__{
schema: schema,
input: input,
parsed: nil,
path: [],
errors: []
}
end
@doc """
Add a error to the context.
## Example
iex> schema = Zoi.string() |> Zoi.refine(fn input, ctx ->
...> if String.length(input) > 5 do
...> :ok
...> else
...> Zoi.Context.add_error(ctx, %Zoi.Error{message: "Input too long"})
...> end
...> end)
...> Zoi.parse(schema, "s")
{:error, [%Zoi.Error{message: "Input too long"}]}
"""
@spec add_error(t(), error()) :: t()
def add_error(%__MODULE__{errors: errors} = context, error) do
error = Zoi.Errors.add_error(errors, error)
%{context | errors: error}
end
@doc false
@spec add_parsed(t(), Zoi.input()) :: t()
def add_parsed(%__MODULE__{} = context, parsed) do
%{context | parsed: parsed}
end
@doc false
@spec add_path(t(), Zoi.Error.path()) :: t()
def add_path(%__MODULE__{} = context, path) do
%{context | path: path}
end
end