#[repr(transparent)]
pub struct Status(pub i32);
Expand description

Operation status. The Furi API switches between using enum FuriStatus, int32_t and uint32_t. Since these all use the same bit representation, we can just “cast” the returns to this type.

Tuple Fields§

§0: i32

Implementations§

source§

impl Status

source

pub const OK: Status = _

Operation completed successfully.

source

pub const ERR: Status = _

Unspecified RTOS error: run-time error but no other error message fits.

source

pub const ERR_TIMEOUT: Status = _

Operation not completed within the timeout period.

source

pub const ERR_RESOURCE: Status = _

Resource not available.

source

pub const ERR_PARAMETER: Status = _

Parameter error.

source

pub const ERR_NO_MEMORY: Status = _

System is out of memory: it was impossible to allocate or reserve memory for the operation.

source

pub const ERR_ISR: Status = _

Not allowed in ISR context: the function cannot be called from interrupt service routines.

source

pub fn description(self) -> &'static str

Describes the status result of the operation.

source

pub fn is_ok(self) -> bool

Was the operation successful?

source

pub fn is_err(self) -> bool

Did the operation error?

source

pub fn err_or<T>(self, ok: T) -> Result<T, Self>

Returns Err(Status) if Status is an error, otherwise Ok(ok).

source

pub fn err_or_else<T>(self, or_else: impl Fn(Self) -> T) -> Result<T, Self>

Returns Err(Status) if Status is an error, otherwise Ok(or_else(Status)).

Trait Implementations§

source§

impl Clone for Status

source§

fn clone(&self) -> Status

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Status

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Status

source§

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

Formats the value using the given formatter. Read more
source§

impl From<i32> for Status

source§

fn from(code: i32) -> Self

Converts to this type from the input type.
source§

impl PartialEq<Status> for Status

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for Status

source§

impl Eq for Status

source§

impl StructuralEq for Status

source§

impl StructuralPartialEq for Status

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.