ArtNet.EncodeError exception (ArtNet v0.1.0)

Exception returned or raised when packet encoding fails.

ArtNet.encode/1 returns this exception inside {:error, exception}. ArtNet.encode!/1 raises it directly.

Summary

Types

t()

Encoding error details.

Functions

message(exception)

Callback implementation for Exception.message/1.

Types

t()

@type t() :: %ArtNet.EncodeError{
  __exception__: true,
  reason:
    {:encode_error, %{key: atom(), type: atom(), value: any()}}
    | {:invalid_data, String.t()}
}

Encoding error details.

{:encode_error, details} - a schema field could not be encoded.
{:invalid_data, reason} - packet construction or validation failed.

Functions

message(exception)

Callback implementation for Exception.message/1.