Brasilex.ValidationError exception (Brasilex v0.3.0)

Copy Markdown View Source

Exception raised when validation fails.

Fields

  • :reason - The validation error atom or tuple
  • :message - Human-readable error message

Error Reasons

Boleto

  • :invalid_length - Wrong number of digits
  • :invalid_format - Contains invalid characters
  • :invalid_checksum - Check digit validation failed
  • {:invalid_field_checksum, n} - Field n check digit validation failed
  • :unknown_type - Could not determine boleto type

State Registration (IE)

  • :invalid_length - Wrong number of digits (expected 9-14)
  • :invalid_format - Contains invalid characters
  • :invalid_checksum - Check digit validation failed

Summary

Types

reason()
t()

Types

reason()

@type reason() ::
  :invalid_length
  | :invalid_format
  | :invalid_checksum
  | {:invalid_field_checksum, pos_integer()}
  | :unknown_type

t()

@type t() :: %Brasilex.ValidationError{
  __exception__: true,
  message: String.t(),
  reason: reason()
}