Calendrical.DateParseError exception (Calendrical v0.6.0)

Copy Markdown

Returned (or raised) by Calendrical.Date.parse/2 when an input string cannot be interpreted as a date.

Carries semantic fields only; the human-readable description is materialised by message/1 so callers can pattern-match on structure (input/locale/calendar) without parsing prose.

Fields

  • :input — the raw string that failed to parse.

  • :locale — the locale the parser tried.

  • :calendar — the CLDR calendar key the parser tried.

Summary

Types

t()

@type t() :: %Calendrical.DateParseError{
  __exception__: term(),
  calendar: atom() | nil,
  input: String.t() | nil,
  locale: atom() | String.t() | nil
}