Localize.PersonNameError exception (Localize Person Names v1.0.0)

Copy Markdown View Source

Exception raised when person name formatting fails.

Raised by Localize.PersonName.to_string!/2 and Localize.PersonName.to_iodata!/2 when the underlying formatting operation returns {:error, reason}.

Summary

Types

t()

A Localize.PersonNameError exception struct.

Functions

Builds a Localize.PersonNameError exception from a string message.

Types

t()

@type t() :: %Localize.PersonNameError{
  __exception__: term(),
  message: String.t() | nil
}

A Localize.PersonNameError exception struct.

Functions

exception(msg)

Builds a Localize.PersonNameError exception from a string message.

Arguments

  • message is a String.t/0 describing the formatting failure.

Returns