Checked

Checked integral type wraps an integral T and customizes its behavior with the help of a Hook type. The type wrapped must be one of the predefined integrals (unqualified), or another instance of Checked.

struct Checked (

Hook = Abort

) if (

isIntegral!T ||

is(T == Checked!(U, H),

)

) {

alias Representation = T;

T payload;

Hook hook;

auto get();

enum Checked!(T, Hook) min;

enum Checked!(T, Hook) max;

this(U rhs);

void opAssign(U rhs);

U opCast();

bool opEquals(U rhs);

size_t toHash();

auto opCmp(U rhs);

auto opCmp(Checked!(U, Hook1) rhs);

auto opUnary();

Checked opUnary();

auto opBinary(Rhs rhs);

auto opBinary(Checked!(U, Hook1) rhs);

auto opBinaryRight(Lhs lhs);

Checked opOpAssign(Rhs rhs);

}

Constructors

this this(U rhs): Constructor taking a value properly convertible to the underlying type. U may be either an integral that can be converted to T without a loss, or another Checked instance whose representation may be in turn converted to T without a loss.

Members

Aliases

Representation alias Representation = T: The type of the integral subject to checking.

Functions

get auto get(): Returns a copy of the underlying value.
opAssign void opAssign(U rhs): Assignment operator. Has the same constraints as the constructor.
opBinary auto opBinary(Rhs rhs)
auto opBinary(Checked!(U, Hook1) rhs): Defines binary operators +, -, *, /, %, ^^, &, |, ^, <<, >>, and >>>. If Hook defines hookOpBinary, opBinary forwards to Checked!(typeof(hook.hookOpBinary!op(get, rhs)), Hook)(hook.hookOpBinary!op(get, rhs)).
opBinaryRight auto opBinaryRight(Lhs lhs): Defines binary operators +, -, *, /, %, ^^, &, |, ^, <<, >>, and >>> for the case when a built-in numeric or Boolean type is on the left-hand side, and a Checked instance is on the right-hand side.
opCast U opCast(): Casting operator to integral, bool, or floating point type. If Hook defines hookOpCast, the call immediately returns hook.hookOpCast!U(get). Otherwise, casting to bool yields get != 0 and casting to another integral that can represent all values of T returns get promoted to U.
opCmp auto opCmp(U rhs)
auto opCmp(Checked!(U, Hook1) rhs): Compares this against rhs for ordering. If Hook defines hookOpCmp, the function forwards to hook.hookOpCmp(get, rhs). Otherwise, the result of the built-in comparison operation is returned.
opEquals bool opEquals(U rhs): Compares this against rhs for equality. If Hook defines hookOpEquals, the function forwards to hook.hookOpEquals(get, rhs). Otherwise, the result of the built-in operation get == rhs is returned.
opOpAssign Checked opOpAssign(Rhs rhs): Defines operators +=, -=, *=, /=, %=, ^^=, &=, |=, ^=, <<=, >>=, and >>>=.
opUnary auto opUnary()
Checked opUnary(): Defines unary operators +, -, ~, ++, and --. Unary + is not overridable and always has built-in behavior (returns this). For the others, if Hook defines hookOpUnary, opUnary forwards to Checked!(typeof(hook.hookOpUnary!op(get)), Hook)(hook.hookOpUnary!op(get)).
toHash size_t toHash(): Generates a hash for this. If Hook defines hookToHash, the call immediately returns hook.hookToHash(payload). If Hook does not implement hookToHash, but it has state, a hash will be generated for the Hook using the built-in function and it will be xored with the hash of the payload.

Variables

hook Hook hook;: hook is a member variable if it has state, or an alias for Hook otherwise.
max enum Checked!(T, Hook) max;: Defines the minimum and maximum. These values are hookable by defining Hook.min and/or Hook.max.
min enum Checked!(T, Hook) min;: Defines the minimum and maximum. These values are hookable by defining Hook.min and/or Hook.max.