Enum ratman_netmod::Error

pub enum Error {
    NotSupported,
    FrameTooLarge,
    ConnectionLost,
    DesequenceFault,
}

Error return types emitted by Endpoint implementations

Underlying hardware errors are entirely shadowed, because it wouldn’t reasonably be possible to encode them all and error messages are prone to confusion. Instead, a simple set of common hardware and buffer related errors was selected to be retunrable.

Routing layers (such as R.A.T.M.A.N. are expected to respond gracefully to all of these errors, so none of them should be considered fatal.

Variants

NotSupported

The requested operation is not supported by an adapter

Valid reasons to return this error might be a routing layer trying to setup a listen handle on platforms that only support basic polling.

This error must not be used for dealing with a Frame that exceeds available buffer capacity!

FrameTooLarge

The provided Frame was too large to send on this adapter

Sometimes a routing layer (such as R.A.T.M.A.N.) will partially ignore the provided size_hint for efficiency reasons and provide a Frame to an adapter that is larger. If a backend has an upper size limit, encoded in the size_hint (or larger), and a Frame exceeds this limit, returning this error is permited.

It will result in the routing later resubmitting a smaller Frame sequence.

ConnectionLost

During the most recent transmission a connection drop occured

This error can be thrown both during send and poll, but should not be returned by listen, as an invalid Frame can simply be dropped.

DesequenceFault

During desequencing an error occured

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

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

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

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

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

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting