ArtNet.DecodeError exception (ArtNet v0.1.0)

Exception returned or raised when packet decoding fails.

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

Summary

Types

t()

Decoding error details.

Functions

message(exception)

Callback implementation for Exception.message/1.

Types

t()

@type t() :: %ArtNet.DecodeError{
  __exception__: true,
  reason:
    {:decode_error, atom()}
    | {:invalid_data, String.t()}
    | {:excess_bytes, binary()}
    | {:invalid_op_code, pos_integer()}
}

Decoding error details.

{:decode_error, field} - a schema field could not be decoded.
{:invalid_data, reason} - header or packet validation failed.
{:excess_bytes, bytes} - schema decoding completed with extra payload bytes.
{:invalid_op_code, op_code} - the OpCode is not supported.

Functions

message(exception)

Callback implementation for Exception.message/1.