Skip to main content

Completion

Struct Completion

pub struct Completion<'a, T, E: RingOp<T>> { /* private fields */ }

👎Deprecated since 3.1.0:

This crate has been marked for formal inclusion in the Agave Unstable API. From v4.0.0 onward, the agave-unstable-api crate feature must be specified to acknowledge use of an interface that may break without warning.

Expand description

Context object passed to RingOp::complete.

Implementations§

impl<T, E: RingOp<T>> Completion<'_, T, E>

pub fn context(&self) -> &T

👎Deprecated since 3.1.0:

This crate has been marked for formal inclusion in the Agave Unstable API. From v4.0.0 onward, the agave-unstable-api crate feature must be specified to acknowledge use of an interface that may break without warning.

Returns a reference to the context value stored in a Ring.

pub fn context_mut(&mut self) -> &mut T

👎Deprecated since 3.1.0:

This crate has been marked for formal inclusion in the Agave Unstable API. From v4.0.0 onward, the agave-unstable-api crate feature must be specified to acknowledge use of an interface that may break without warning.

Returns a mutable reference to the context value stored in a Ring.

pub fn push(&mut self, op: E)

👎Deprecated since 3.1.0:

This crate has been marked for formal inclusion in the Agave Unstable API. From v4.0.0 onward, the agave-unstable-api crate feature must be specified to acknowledge use of an interface that may break without warning.

Pushes an operation to the submission queue.

This can be used to push new operations from within RingOp::complete.

See also Ring::push.

Auto Trait Implementations§

impl<'a, T, E> Freeze for Completion<'a, T, E>
where E: Freeze,

impl<'a, T, E> RefUnwindSafe for Completion<'a, T, E>
where T: RefUnwindSafe, E: RefUnwindSafe,

impl<'a, T, E> Send for Completion<'a, T, E>
where E: Send, T: Send,

impl<'a, T, E> Sync for Completion<'a, T, E>
where T: Sync, E: Sync,

impl<'a, T, E> Unpin for Completion<'a, T, E>
where E: Unpin,

impl<'a, T, E> UnsafeUnpin for Completion<'a, T, E>
where E: UnsafeUnpin,

impl<'a, T, E> !UnwindSafe for Completion<'a, T, E>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.