AuditLog.InvalidValueError exception (AuditLog v0.3.1)

Describes a rejected value without retaining or printing that value.

Non-bang constructors return this exception in an {:error, error} tuple. Bang functions raise the same value. Callers may match on :reason and :field; the message tells an operator how to correct the input.

Summary

Types

reason()

t()

Functions

new(reason, field \\ nil)

Builds an error with a stable reason and a corrective message.

Types

reason()

@type reason() ::
  :blank
  | :composite_primary_key
  | :duplicate_options
  | :invalid_actor
  | :invalid_context
  | :invalid_datetime
  | :invalid_metadata
  | :invalid_options
  | :invalid_order
  | :invalid_prefix
  | :invalid_schema
  | :invalid_schema_state
  | :invalid_subject
  | :invalid_subject_id
  | :invalid_sys_period
  | :invalid_time_window
  | :invalid_uuid
  | :missing_primary_key
  | :missing_schema_source
  | :nil_primary_key
  | :not_stringable
  | :unknown_options
  | :unpersisted_event

t()

@type t() :: %AuditLog.InvalidValueError{
  __exception__: term(),
  field: atom() | nil,
  message: String.t(),
  reason: reason()
}

Functions

new(reason, field \\ nil)

@spec new(reason(), atom() | nil) :: t()

Builds an error with a stable reason and a corrective message.