-module(qrkit@error).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch, inline]).
-define(FILEPATH, "src/qrkit/error.gleam").
-export_type([encode_error/0, matrix_access_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(" Encoding errors returned by qrkit's public API.\n").

-type encode_error() :: {data_exceeds_capacity, integer(), integer()} |
    {invalid_version, integer()} |
    {invalid_eci_designator, integer()} |
    {unsupported_character, integer(), binary()} |
    empty_input |
    {incompatible_options, binary()}.

-type matrix_access_error() :: {module_out_of_bounds,
        integer(),
        integer(),
        integer(),
        integer()}.