Struct IoRingError 

pub struct IoRingError { /* private fields */ }

An error from an IoRing API call.

Every IoRing entry point reports failure as an HRESULT, not through GetLastError the way most of Win32 does, so this crate cannot reuse io::Error::last_os_error the way windows-overlapped-io-sys does.

Matching on one of these

A kernel-reported failure always reaches a caller as an io::Error whose kind is io::ErrorKind::Other, because there is no faithful ErrorKind for most IORING_E_* conditions (M10.2, D-30). The HRESULT is not lost – it is this value, behind a downcast – but kind() will not find it. kind() discriminates only this crate’s own rejections, which use Unsupported, InvalidInput, and AlreadyExists.

So a consumer branching on a ring condition – most often IORING_E_SUBMISSION_QUEUE_FULL, the backpressure signal every push’s docs name – asks through IoRingErrorExt (M10.5), which is the downcast plus the comparison named once rather than hand-rolled:

use windows_ioring_sys::IoRingErrorExt;

fn classify(error: &std::io::Error) -> &'static str {
    if error.is_submission_queue_full() {
        "backpressure: submit, drain, retry"
    } else if let Some(condition) = error.ring_condition() {
        condition.name()
    } else {
        "not a ring condition"
    }
}

Implementations

impl IoRingError

pub fn code(&self) -> HRESULT

The raw HRESULT.

pub fn name(&self) -> Option<&'static str>

The named IORING_E_* constant this value matches, if any.

Derived from IoRingError::condition rather than matching the HRESULT a second time, so the two can never disagree about which codes are named (M10.5).

pub fn condition(&self) -> Option<RingCondition>

The named condition this error reports, or None for an HRESULT this crate does not name (M10.5).

match on this when a consumer needs to distinguish several conditions; use a predicate like IoRingError::is_submission_queue_full for a single branch.

pub fn is_submission_queue_full(&self) -> bool

Whether this is IORING_E_SUBMISSION_QUEUE_FULL: the backpressure signal every push’s documentation names (M3.3).

Recoverable, and the one condition a normal submission loop is expected to branch on: submit what is already queued, drain completions, and retry the push.

pub fn is_completion_queue_too_full(&self) -> bool

Whether this is IORING_E_COMPLETION_QUEUE_TOO_FULL: the completion queue has no room for further results, so completions must be drained with crate::IoRing::try_pop.

pub fn is_submit_in_progress(&self) -> bool

Whether this is IORING_E_SUBMIT_IN_PROGRESS: another submit is already running on this ring.

Trait Implementations

impl Clone for IoRingError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for IoRingError

impl Debug for IoRingError

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

Formats the value using the given formatter.

impl Display for IoRingError

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

Formats the value using the given formatter.

impl Eq for IoRingError

impl Error for IoRingError

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.

impl PartialEq for IoRingError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IoRingError