Ollixir.RequestError exception (Ollixir v0.1.1)

Copy Markdown View Source

Exception raised for pre-request validation errors.

This error is raised before any HTTP request is made when:

  • Required parameters are missing
  • Parameters have invalid types
  • Parameters have invalid values
  • Configuration is invalid

Fields

  • message - Human-readable error description
  • field - The field that caused the error (if applicable)
  • reason - Structured reason for the error

Summary

Types

t()

Functions

invalid_type(field, value, expected)

Create an invalid type error.

invalid_value(field, value, constraint)

Create an invalid value error.

missing_field(field)

Create a missing field error.

Types

t()

@type t() :: %Ollixir.RequestError{
  __exception__: true,
  field: atom() | nil,
  message: String.t(),
  reason: atom() | tuple()
}

Functions

invalid_type(field, value, expected)

@spec invalid_type(atom(), any(), String.t()) :: t()

Create an invalid type error.

invalid_value(field, value, constraint)

@spec invalid_value(atom(), any(), String.t()) :: t()

Create an invalid value error.

missing_field(field)

@spec missing_field(atom()) :: t()

Create a missing field error.