Enum Error 

#[non_exhaustive]
pub enum Error {
    InvalidConfig {
        message: Cow<'static, str>,
        fix: Cow<'static, str>,
    },
    BackendUnavailable {
        message: Cow<'static, str>,
        fix: Cow<'static, str>,
    },
    Submission {
        message: Cow<'static, str>,
        fix: Cow<'static, str>,
    },
    Completion {
        message: Cow<'static, str>,
        fix: Cow<'static, str>,
    },
    ResourceExhausted {
        message: Cow<'static, str>,
        fix: Cow<'static, str>,
    },
    Unsupported {
        message: Cow<'static, str>,
        fix: Cow<'static, str>,
    },
    Canceled {
        message: Cow<'static, str>,
        fix: Cow<'static, str>,
    },
    Timeout {
        message: Cow<'static, str>,
        fix: Cow<'static, str>,
    },
    Validation {
        message: Cow<'static, str>,
        fix: Cow<'static, str>,
    },
    ProcessState {
        message: Cow<'static, str>,
        fix: Cow<'static, str>,
    },
    Io {
        message: Cow<'static, str>,
        source: Error,
        fix: Cow<'static, str>,
    },
}

Errors produced by ring setup, submission, and completion handling.

use wireshift::Error;

let err = Error::invalid_config("queue_depth must be non-zero");
assert!(err.to_string().contains("Fix:"));

Variants (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.

InvalidConfig

The supplied configuration is invalid.

Fields

message: Cow<'static, str>

Error summary.

fix: Cow<'static, str>

Suggested remediation.

BackendUnavailable

The selected backend is unavailable.

Fields

message: Cow<'static, str>

Error summary.

fix: Cow<'static, str>

Suggested remediation.

Submission

Submission could not be accepted.

Fields

message: Cow<'static, str>

Error summary.

fix: Cow<'static, str>

Suggested remediation.

Completion

Completion routing failed internally.

Fields

message: Cow<'static, str>

Error summary.

fix: Cow<'static, str>

Suggested remediation.

ResourceExhausted

Resource exhaustion was hit.

Fields

message: Cow<'static, str>

Error summary.

fix: Cow<'static, str>

Suggested remediation.

Unsupported

The caller attempted an unsupported operation.

Fields

message: Cow<'static, str>

Error summary.

fix: Cow<'static, str>

Suggested remediation.

Canceled

A cancellation request succeeded.

Fields

message: Cow<'static, str>

Error summary.

fix: Cow<'static, str>

Suggested remediation.

Timeout

The operation timed out.

Fields

message: Cow<'static, str>

Error summary.

fix: Cow<'static, str>

Suggested remediation.

Validation

Input validation failed.

Fields

message: Cow<'static, str>

Error summary.

fix: Cow<'static, str>

Suggested remediation.

ProcessState

The current process state is incompatible with the backend.

Fields

message: Cow<'static, str>

Error summary.

fix: Cow<'static, str>

Suggested remediation.

Io

A wrapped I/O error.

Fields

message: Cow<'static, str>

Human-readable context.

source: Error

Source I/O error.

fix: Cow<'static, str>

Suggested remediation.

Implementations

impl Error

pub fn invalid_config(message: impl Into<Cow<'static, str>>) -> Self

Creates an invalid configuration error with a standard fix hint.

pub fn io( message: impl Into<Cow<'static, str>>, source: Error, fix: impl Into<Cow<'static, str>>, ) -> Self

Creates an I/O-flavoured error.

pub fn validation( message: impl Into<Cow<'static, str>>, fix: impl Into<Cow<'static, str>>, ) -> Self

Creates a validation error.

pub fn submission( message: impl Into<Cow<'static, str>>, fix: impl Into<Cow<'static, str>>, ) -> Self

Creates a submission error.

pub fn completion( message: impl Into<Cow<'static, str>>, fix: impl Into<Cow<'static, str>>, ) -> Self

Creates a completion error.

pub fn resource_exhausted( message: impl Into<Cow<'static, str>>, fix: impl Into<Cow<'static, str>>, ) -> Self

Creates a resource exhaustion error.

pub fn backend_unavailable( message: impl Into<Cow<'static, str>>, fix: impl Into<Cow<'static, str>>, ) -> Self

Creates a backend unavailable error.

pub fn canceled( message: impl Into<Cow<'static, str>>, fix: impl Into<Cow<'static, str>>, ) -> Self

Creates a cancellation error.

pub fn unsupported(message: impl Into<Cow<'static, str>>) -> Self

Creates an unsupported-operation error.

pub fn timeout( message: impl Into<Cow<'static, str>>, fix: impl Into<Cow<'static, str>>, ) -> Self

Creates a timeout error.

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, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for Error

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

Returns 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.