Struct esp_idf_hal::sys::EspError

pub struct EspError(/* private fields */);

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: i32) -> Option<EspError>

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

pub const fn from_non_zero(error: NonZero<i32>) -> EspError

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

pub const fn from_infallible<const E: i32>() -> EspError

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

pub fn check_and_return<T>(error: i32, value: T) -> Result<T, EspError>

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: i32) -> Result<(), EspError>

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) -> i32

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<(), Error>

Formats the value using the given formatter.

impl Display for EspError

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

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 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>(&'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.

impl From<EspError> for Can02Error

fn from(e: EspError) -> Self

Converts to this type from the input type.

impl From<EspError> for CanError

fn from(e: EspError) -> Self

Converts to this type from the input type.

impl From<EspError> for EspIOError

fn from(e: EspError) -> Self

Converts to this type from the input type.

impl From<EspError> for GpioError

fn from(e: EspError) -> Self

Converts to this type from the input type.

impl From<EspError> for I2cError

fn from(e: EspError) -> Self

Converts to this type from the input type.

impl From<EspError> for PwmError

fn from(e: EspError) -> Self

Converts to this type from the input type.

impl From<EspError> for SerialError

fn from(e: EspError) -> Self

Converts to this type from the input type.

impl From<EspError> for SpiError

fn from(e: EspError) -> Self

Converts to this type from the input type.

impl Hash for EspError

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

where __H: Hasher,

Feeds this value into the given [Hasher].

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

where H: Hasher, Self: Sized,

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

impl PartialEq 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: &Rhs) -> bool

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

impl Copy for EspError

impl Eq for EspError

impl StructuralPartialEq for EspError