Struct esp_idf_sys::EspError

#[repr(transparent)]
pub struct EspError(_);

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

impl EspError

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

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

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

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

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.

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.

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.

pub fn panic(&self)

Panic with a specific error message of the contained esp_err_t.

pub fn code(&self) -> esp_err_t

Get the wrapped esp_err_t.

Trait Implementations

impl Clone for EspError

fn clone(&self) -> EspError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EspError

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

Formats the value using the given formatter.

impl Display for EspError

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

Formats the value using the given formatter.

impl Error for EspError

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide(&'a self, req: &mut Demand<'a>)

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

Provides type based access to context intended for error reports.

impl Hash for EspError

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl PartialEq<EspError> for EspError

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

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

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

This method tests for !=.

impl Copy for EspError

impl Eq for EspError

impl StructuralEq for EspError

impl StructuralPartialEq for EspError