ExIcaoVds.Error (ex_icao_vds v0.3.2)

Structured error type returned by all public API functions.

Summary

Types

code()

t()

Functions

new(code, message, opts \\ [])

Build a new Error. opts accepts :details, :cause, :safe_to_show?.

Types

code()

@type code() ::
  :invalid_input
  | :missing_required_field
  | :unsupported_profile
  | :unsupported_version
  | :invalid_header
  | :invalid_message_zone
  | :invalid_signature_zone
  | :signature_failed
  | :invalid_signature
  | :unknown_key
  | :untrusted_key
  | :unknown_certificate
  | :untrusted_certificate
  | :expired_certificate
  | :revoked_certificate
  | :encryption_failed
  | :decryption_failed
  | :carrier_generation_failed
  | :carrier_decode_failed
  | :payload_too_large
  | :kms_unavailable
  | :hsm_unavailable
  | :configuration_error

t()

@type t() :: %ExIcaoVds.Error{
  cause: term(),
  code: code(),
  details: map(),
  message: String.t(),
  safe_to_show?: boolean()
}

Functions

new(code, message, opts \\ [])

@spec new(code(), String.t(), keyword()) :: t()

Build a new Error. opts accepts :details, :cause, :safe_to_show?.