Enum CResult 

#[repr(u8)]
pub enum CResult<TOk, TErr> {
    Ok(TOk),
    Err(TErr),
}

This enum is essentially the same as the standard Result, except it is #[repr(C)] and thus safe to use a cross the ffi boundaries.

Note that the safety is guaranteed only for the enum itself, not for the data it holds. Meaning you still have to manually use #[repr(C)] on TOk and TErr for the inner data to be ffi safe.

It additionally provides const variants of Result methods.

Variants

Ok(TOk)

Err(TErr)

Implementations

impl<TOk, TErr> CResult<TOk, TErr>

pub const fn is_ok(&self) -> bool

Returns true if the enum holds CResult::Ok, false otherwise.

pub const fn is_err(&self) -> bool

Returns true if the enum holds CResult::Err, false otherwise.

pub const fn unwrap(self) -> TOk

Unwraps currently stored CResult::Ok value.

Panics

Only when self actually holds a CResult::Err value.

pub const unsafe fn unwrap_unchecked(self) -> TOk

Unwraps currently stored CResult::Ok value.

Safety

This function does not verify whether the stored value is actually CResult::Ok. The behaviour is undefined if it is not.

pub const fn unwrap_err(self) -> TErr

Unwraps currently stored CResult::Err value.

Panics

Only when self actually holds an CResult::Ok value.

pub const unsafe fn unwrap_err_unchecked(self) -> TErr

Unwraps currently stored CResult::Err value.

Safety

This function does not verify whether the stored value is actually CResult::Err. The behaviour is undefined if it is not.

pub const fn into_result(self) -> Result<TOk, TErr>

Converts CResult into standard Result.

pub const fn from_result(result: Result<TOk, TErr>) -> Self

Converts standard Result into CResult.

Trait Implementations

impl<TOk: Debug, TErr: Debug> Debug for CResult<TOk, TErr>

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

Formats the value using the given formatter.

impl<TOk, TErr> From<CResult<TOk, TErr>> for Result<TOk, TErr>

fn from(value: CResult<TOk, TErr>) -> Self

Converts to this type from the input type.

impl<TOk, TErr> From<Result<TOk, TErr>> for CResult<TOk, TErr>

fn from(value: Result<TOk, TErr>) -> Self

Converts to this type from the input type.