-module(gleam@should).
-compile(no_auto_import).

-export([equal/2, not_equal/2, be_true/1, be_false/1, be_ok/1, be_error/1, fail/0]).
-export_type([expectation/0]).

-type expectation() :: any().

-spec equal(Y, Y) -> expectation().
equal(A, B) ->
    gleam_stdlib:should_equal(A, B).

-spec not_equal(Z, Z) -> expectation().
not_equal(A, B) ->
    gleam_stdlib:should_not_equal(A, B).

-spec be_true(boolean()) -> expectation().
be_true(Actual) ->
    gleam_stdlib:should_equal(Actual, true).

-spec be_false(boolean()) -> expectation().
be_false(Actual) ->
    gleam_stdlib:should_equal(Actual, false).

-spec be_ok({ok, any()} | {error, any()}) -> expectation().
be_ok(A) ->
    gleam_stdlib:should_be_ok(A).

-spec be_error({ok, any()} | {error, any()}) -> expectation().
be_error(A) ->
    gleam_stdlib:should_be_error(A).

-spec fail() -> expectation().
fail() ->
    be_true(false).