Struct esp_idf_sys::EspError

source ·
pub struct EspError(/* private fields */);
Expand description

A wrapped esp_err_t to check if an error occurred.

An esp_err_t is returned from most esp-idf APIs as a status code. If it is equal to ESP_OK it means no error occurred.

Implementations§

source§

impl EspError

source

pub const fn from(error: esp_err_t) -> Option<Self>

Wrap an esp_err_t, return [Some] if error is not ESP_OK.

source

pub const fn from_non_zero(error: NonZeroI32) -> Self

Wrap a [NonZeroI32]. Since ESP_OK is 0, this can never fail;

source

pub const fn from_infallible<const E: esp_err_t>() -> Self

Wrap an esp_err_t, throw a compile time error if error is ESP_OK.

source

pub fn check_and_return<T>(error: esp_err_t, value: T) -> Result<T, Self>

Convert error into a [Result] with Ok(value) if no error occurred.

If error is ESP_OK return [Ok] of value otherwise return [Err] of wrapped error.

source

pub fn convert(error: esp_err_t) -> Result<(), Self>

Convert error into a [Result] with Ok(()) if not error occurred..

If error equals to ESP_OK return [Ok], otherwise return [Err] with the wrapped esp_err_t.

source

pub fn panic(&self)

Panic with a specific error message of the contained esp_err_t.

source

pub fn code(&self) -> esp_err_t

Get the wrapped esp_err_t.

Trait Implementations§

source§

impl Clone for EspError

source§

fn clone(&self) -> EspError

Returns a copy of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
source§

impl Debug for EspError

source§

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

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

impl Display for EspError

source§

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

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

impl Error for EspError

1.30.0§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
1.0.0§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl Hash for EspError

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher]. Read more
1.3.0§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher]. Read more
source§

impl PartialEq for EspError

source§

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

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

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 EspError

source§

impl Eq for EspError

source§

impl StructuralPartialEq for EspError

Auto Trait Implementations§

§

impl Freeze for EspError

§

impl RefUnwindSafe for EspError

§

impl Send for EspError

§

impl Sync for EspError

§

impl Unpin for EspError

§

impl UnwindSafe for EspError

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> CloneToUninit for T
where T: Copy,

§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> ToString for T
where T: Display + ?Sized,

§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
§

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

Performs the conversion.
§

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

§

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

The type returned in the event of a conversion error.
§

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

Performs the conversion.