Skip to main content

Error

Enum Error 

Source
#[non_exhaustive]
pub enum Error {
Show 22 variants NotRegistered, InvalidParam, NoMemory, Timeout, NotSupported, QueueFull, MlFailed, NetRefused, NetUnreachable, NetAddrInUse, NetReset, NetDnsFail, NetClosed, BusNack, BusBusy, BusError, QueueEmpty, WouldBlock, Eof, Inval, NotFound, Unknown(i32),
}
Expand description

oveRTOS error codes, mapped from C OVE_ERR_* defines in ove/types.h.

When adding a new variant, update from_code, to_code, Display, and the _assert_codes_match function below.

The enum is #[non_exhaustive] so the substrate can add new OVE_ERR_* codes (mapped to fresh variants here) without breaking downstream match blocks at compile time. Callers should always include a _ => … arm. Matches std::io::ErrorKind convention.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

NotRegistered

The requested resource or subsystem has not been registered (OVE_ERR_NOT_REGISTERED).

§

InvalidParam

One or more parameters passed to the API were invalid (OVE_ERR_INVALID_PARAM).

§

NoMemory

Heap or static allocation failed (OVE_ERR_NO_MEMORY).

§

Timeout

The operation did not complete within the allowed time (OVE_ERR_TIMEOUT).

§

NotSupported

The requested operation is not supported by this platform (OVE_ERR_NOT_SUPPORTED).

§

QueueFull

The queue was full and the item could not be enqueued (OVE_ERR_QUEUE_FULL).

§

MlFailed

ML inference or model loading failed (OVE_ERR_ML_FAILED).

§

NetRefused

Remote peer refused the connection (OVE_ERR_NET_REFUSED).

§

NetUnreachable

Network or host is unreachable (OVE_ERR_NET_UNREACHABLE).

§

NetAddrInUse

Local address already in use (OVE_ERR_NET_ADDR_IN_USE).

§

NetReset

Connection was reset by the remote peer (OVE_ERR_NET_RESET).

§

NetDnsFail

DNS name resolution failed (OVE_ERR_NET_DNS_FAIL).

§

NetClosed

Connection closed by the remote peer (OVE_ERR_NET_CLOSED).

§

BusNack

Bus peripheral: device did not acknowledge (OVE_ERR_BUS_NACK).

§

BusBusy

Bus peripheral: bus is busy / arbitration lost (OVE_ERR_BUS_BUSY).

§

BusError

Bus peripheral: generic bus error (OVE_ERR_BUS_ERROR).

§

QueueEmpty

The queue was empty and no item could be received (OVE_ERR_QUEUE_EMPTY).

§

WouldBlock

A non-blocking operation would have had to block (OVE_ERR_WOULD_BLOCK).

§

Eof

End of file / directory iterator exhausted (OVE_ERR_EOF).

§

Inval

Argument or state is invalid for this operation (OVE_ERR_INVAL).

§

NotFound

Requested key / entry / resource was not found (OVE_ERR_NOT_FOUND).

§

Unknown(i32)

An error code not covered by the above variants; the raw code is preserved.

Implementations§

Source§

impl Error

Source

pub fn from_code(code: i32) -> Result<()>

Convert a C return code to Result<()>. Zero (OVE_OK) maps to Ok(()), negative values map to the corresponding Error variant.

Source

pub fn to_code(self) -> i32

Convert back to the raw C error code.

Source

pub fn is_net_error(&self) -> bool

Returns true if this is a networking-related error.

Source

pub fn is_bus_error(&self) -> bool

Returns true if this is a bus peripheral error (I2C/SPI).

Trait Implementations§

Source§

impl Clone for Error

Source§

fn clone(&self) -> Error

Returns a duplicate 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 Error

Source§

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

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

impl Display for Error

Source§

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

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

impl Error for Error

Source§

fn kind(&self) -> ErrorKind

Convert error to a generic I2C error kind. Read more
Source§

impl Error for Error

Source§

fn kind(&self) -> ErrorKind

Convert error to a generic SPI error kind. Read more
Source§

impl Error for Error

Source§

fn kind(&self) -> ErrorKind

Convert error to a generic error kind Read more
Source§

impl Error for Error

Source§

fn kind(&self) -> ErrorKind

Get the kind of this error.
Source§

impl Error for Error

core::error::Error is stable since Rust 1.81; our MSRV is 1.85 so the impl can be unconditional. std::error::Error is a re-export of core::error::Error (also since 1.81), so this single impl covers both no_std and std consumers — no #[cfg(feature = "std")] gymnastics. The default source() -> None is correct: ove::Error doesn’t chain to a lower-level cause.

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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 PartialEq for Error

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for Error

Source§

impl Eq for Error

Source§

impl StructuralPartialEq for Error

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.