Struct Res 

pub struct Res(/* private fields */);

An opaque result type for error handling without exposing error details.

This type is designed to prevent side-channel attacks by not revealing specific error information. It only indicates success or failure.

Implementations

impl Res

pub const OK: Self

Represents a successful result.

pub const ERR: Self

Represents an error result.

pub const fn new() -> Self

Creates a new Res instance initialized to OK.

Returns

A new Res instance representing success.

pub const fn is_ok(&self) -> bool

Checks if the result is OK (successful).

Returns

true if the result is OK, false otherwise.

pub const fn is_err(&self) -> bool

Checks if the result is an error.

Returns

true if the result is an error, false otherwise.

pub fn check(&mut self, res: bool)

Updates the result based on a boolean condition.

If res is false, this method will set the Res to an error state.

Arguments

• res - A boolean representing a condition to check.

pub fn ensure_1(&mut self, res: c_int)

Ensures that a C integer result is equal to 1.

Sets the Res to an error state if the input is not 1.

Arguments

• res - A C integer to check.

pub fn ensure_0(&mut self, res: c_int)

Ensures that a C integer result is equal to 0.

Sets the Res to an error state if the input is not 0.

Arguments

• res - A C integer to check.

pub fn ensure_pos(&mut self, res: c_int)

Ensures that a C integer result is positive.

Sets the Res to an error state if the input is not positive.

Arguments

• res - A C integer to check.

pub fn ensure(&mut self, res: Self)

Combines this Res with another Res.

The result will be OK only if both Res instances are OK.

Arguments

• res - Another Res instance to combine with this one.

pub fn unit_err<OK>(self, ok: OK) -> Result<OK, Unspecified>

Converts the Res into a Result<OK, Unspecified>.

Warning

This method is not constant time and should be used carefully in security-sensitive contexts.

Arguments

• ok - The value to return in the Ok variant if the Res is OK.

Returns

Ok(ok) if the Res is OK, Err(Unspecified) otherwise.

pub fn unit_err_with<F, OK>(self, ok: F) -> Result<OK, Unspecified>

where F: FnOnce() -> OK,

Converts the Res into a Result<OK, Unspecified>, with a closure for the OK case.

Warning

This method is not constant time and should be used carefully in security-sensitive contexts.

When to Use

Use this method when the creation of the OK value depends on the result being OK for safety reasons. The closure is only called if the Res is OK, ensuring that any preconditions for the OK value’s creation are met.

Arguments

• ok - A closure that returns the value for the Ok variant if the Res is OK.

Returns

Ok(ok()) if the Res is OK, Err(Unspecified) otherwise.

pub fn unwrap(self)

Unwraps the Res, panicking if it’s an error.

Panics

Panics if the Res is an error.

Warning

This method should generally be avoided in production code, as it can lead to program termination. It’s primarily useful for testing or in situations where an error truly represents an unrecoverable state.

Trait Implementations

impl Debug for Res

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Res

fn default() -> Self

Returns the “default value” for a type.