Skip to main content

CompletionStatus

Struct CompletionStatus 

Source
pub struct CompletionStatus { /* private fields */ }
Expand description

A read-only view of whether the completion queue has entries pending.

Obtained from CompletionQueue::status. Unlike the queue itself this borrows nothing, so it can be captured once at startup and consulted from anywhere afterwards. The check costs two loads, with no system call, no locking, and no access to the ring — which is what a thread-per-core runtime needs on its preemption check, where reaching the queue would cost more than the comparison does.

§Staleness

The answer is stale as soon as it is returned: the kernel may post a completion immediately after the load. This is inherent — any check that does not enter the kernel is a snapshot — and it makes this suitable for hints such as “should I stop what I am doing and poll?”, where being one iteration late costs nothing. It is not a synchronization primitive, and CompletionQueue::is_empty carries exactly the same caveat.

Implementations§

Source§

impl CompletionStatus

Source

pub fn is_empty(&self) -> bool

Returns true if the kernel has posted no completions beyond those already consumed.

See the note on staleness in the type documentation.

Trait Implementations§

Source§

impl Debug for CompletionStatus

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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