Struct Requires

pub struct Requires<C, Raise, Err>
where
    C: Fn(Vector) -> Vector,
    Raise: FnOnce() -> Err,
{
    pub cond: C,
    /* private fields */
}

Available on crate feature require only.

Requires is the final representation of a requirement, usable in the requirements! macro.

When you use the requirement! macro it will expand into a constant function which returns a Requires instance.

Generics

• C: The required condition
• Raise: If the requirement was not fulfilled this is invoked to raise the corresponding Err
• Err: The error to Raise if the requirement was not fulfilled

Fields

cond: C

The required condition

Implementations

impl<C, Raise, Err> Requires<C, Raise, Err>

where C: Fn(Vector) -> Vector, Raise: FnOnce() -> Err,

pub const fn new(cond: C, raise: Raise) -> Self

Create a new Requires instance

Trait Implementations

impl<C, Raise, Err> Condition for Requires<C, Raise, Err>

where C: Fn(Vector) -> Vector, Raise: FnOnce() -> Err,

fn check(&mut self, vector: Vector) -> MoveMask

Compute the condition over the vector, if any bit was set update seen to true.

Returns

The MoveMask used to extract the condition result, used to check validity of the input, ensuring each byte fulfilled at least one condition.

type Error = Err

The error type associated with the requirement. When used in requirements all the error types must implement Into to a common type.

fn ok(self) -> Result<(), Self::Error>

Check that the condition was met at least once, used internally by the requirements! macro