Struct ResultCode

#[repr(transparent)]
pub struct ResultCode(pub Result);

Validity checker of raw ctru_sys::Result codes.

This struct supports the “try” syntax (?) to convert to an Error::Os.

Example

use ctru::error::{Result, ResultCode};

pub fn main() -> Result<()> {
    // We run an unsafe function which returns a `ctru_sys::Result`.
    let result: ctru_sys::Result = unsafe { ctru_sys::hidInit() };

    // The result code is parsed and any possible error gets returned by the function.
    ResultCode(result)?;
    Ok(())
}

Tuple Fields

0: Result

Trait Implementations

impl Clone for ResultCode

fn clone(&self) -> ResultCode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ResultCode

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

Formats the value using the given formatter.

impl From<ResultCode> for Error

fn from(err: ResultCode) -> Self

Converts to this type from the input type.

impl FromResidual for ResultCode

fn from_residual(e: <Self as Try>::Residual) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2)

Constructs the type from a compatible Residual type.

impl Ord for ResultCode

fn cmp(&self, other: &ResultCode) -> Ordering

This method returns an [Ordering] between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ResultCode

fn eq(&self, other: &ResultCode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ResultCode

fn partial_cmp(&self, other: &ResultCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Try for ResultCode

type Output = ()

🔬This is a nightly-only experimental API. (try_trait_v2)

The type of the value produced by ? when not short-circuiting.

type Residual = Error

🔬This is a nightly-only experimental API. (try_trait_v2)

The type of the value passed to [FromResidual::from_residual] as part of ? when short-circuiting.

fn from_output(_: Self::Output) -> Self

🔬This is a nightly-only experimental API. (try_trait_v2)

Constructs the type from its Output type.

fn branch(self) -> ControlFlow<Self::Residual, Self::Output>

🔬This is a nightly-only experimental API. (try_trait_v2)

Used in ? to decide whether the operator should produce a value (because this returned [ControlFlow::Continue]) or propagate a value back to the caller (because this returned [ControlFlow::Break]).

impl Copy for ResultCode

impl Eq for ResultCode

impl StructuralPartialEq for ResultCode