Surgex.Parser.StringParser (Surgex v5.0.0) View Source

Available options:

trim is trimming whitespaces from the string, takes priority over min and max options
min is a minimal length of the string, returns :too_short error symbol
max is a maximal length of the string, returns :too_long error symbol
regex - input string must match passed regular expression, this is done after trimming

Link to this section Summary

errors()

option()

errors() :: :too_short | :too_long | :invalid_string | :bad_format

option() ::
  {:trim, boolean()}
  | {:min, integer()}
  | {:max, integer()}
  | {:regex, Regex.t()}

call(term(), [option()]) :: {:ok, String.t() | nil} | {:error, errors()}

check_regex(%{opts: list(), value: String.t(), error: nil}) :: %{
  opts: list(),
  value: String.t(),
  error: nil | :bad_format
}

trim(%{opts: list(), value: String.t(), error: nil}) :: %{
  opts: list(),
  value: String.t(),
  error: nil
}

validate_max(%{opts: list(), value: String.t(), error: nil}) :: %{
  opts: list(),
  value: String.t(),
  error: nil | :too_long
}

validate_min(%{opts: list(), value: String.t(), error: nil}) :: %{
  opts: list(),
  value: String.t(),
  error: nil | :too_short
}