WaitForIt.Waitable protocol (WaitForIt v2.3.0)

Protocol used for evaluating waitable expressions against waiting conditions to determine if waiting should continue or halt with a final value.

Summary

Types

env()

The caller's compile-time environment, threaded through for telemetry and error reporting.

t()

All the types that implement this protocol.

value()

wait_type()

Functions

evaluate(waitable, env)

Evaluates the waitable expression to provide its value, or to continue to wait.

handle_timeout(waitable, last_value, env)

Provides the final value of the waitable expression in the event of a timeout.

wait_type(waitable)

Types

env()

@type env() :: Macro.Env.t() | nil

The caller's compile-time environment, threaded through for telemetry and error reporting.

It is nil for the functional WaitForIt.until/2 API, which has no Macro.Env.

t()

@type t() :: term()

All the types that implement this protocol.

value()

@type value() :: any()

wait_type()

@type wait_type() :: atom()

Functions

evaluate(waitable, env)

@spec evaluate(t(), env()) :: {:halt, value()} | {:cont, value()}

Evaluates the waitable expression to provide its value, or to continue to wait.

It should return {:halt, value} if the wait is over and the final value of the waitable expression has been determined, or {:cont, value} if waiting should continue.

handle_timeout(waitable, last_value, env)

@spec handle_timeout(t(), value(), env()) :: value()

Provides the final value of the waitable expression in the event of a timeout.

wait_type(waitable)

@spec wait_type(t()) :: wait_type()