Predicator.Errors (predicator v2.2.0)

Common utilities for error formatting across all Predicator error modules.

This module provides shared functions for formatting error messages, type names, and operation names consistently across all error types.

Summary

Functions

expected_type_name(type)

Formats an expected type name for error messages with proper articles.

operation_display_name(op)

Formats an operation name for user-friendly error messages.

type_name_with_value(type, value)

Formats a type name with its value for error messages.

Functions

expected_type_name(type)

@spec expected_type_name(atom()) :: String.t()

Formats an expected type name for error messages with proper articles.

Examples

iex> Predicator.Errors.expected_type_name(:integer)
"an integer"

iex> Predicator.Errors.expected_type_name(:boolean)
"a boolean"

iex> Predicator.Errors.expected_type_name(:custom_type)
"a custom_type"

operation_display_name(op)

@spec operation_display_name(atom()) :: String.t()

Formats an operation name for user-friendly error messages.

Examples

iex> Predicator.Errors.operation_display_name(:add)
"Arithmetic add"

iex> Predicator.Errors.operation_display_name(:logical_and)
"Logical AND"

iex> Predicator.Errors.operation_display_name(:unary_bang)
"Logical NOT"

type_name_with_value(type, value)

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

Formats a type name with its value for error messages.

Examples

iex> Predicator.Errors.type_name_with_value(:string, "hello")
"\"hello\" (string)"

iex> Predicator.Errors.type_name_with_value(:integer, 42)
"42 (integer)"

iex> Predicator.Errors.type_name_with_value(:undefined, :undefined)
":undefined (undefined)"