-module(cangaroo@errors).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch, inline]).
-define(FILEPATH, "src/cangaroo/errors.gleam").
-export_type([can_error/0]).

-if(?OTP_RELEASE >= 27).
-define(MODULEDOC(Str), -moduledoc(Str)).
-define(DOC(Str), -doc(Str)).
-else.
-define(MODULEDOC(Str), -compile([])).
-define(DOC(Str), -compile([])).
-endif.

?MODULEDOC(
    " Error types for cangaroo.\n"
    "\n"
    " This module defines the error types that can be returned by cangaroo.\n"
    " All functions in the `cangaroo` module return\n"
    " `Result` types with `CanError` as the error variant.\n"
).

-type can_error() :: {start_link_error, binary()} |
    {interface_bound_error, binary()} |
    {unknown_error, binary()} |
    invalid_message_type_error.