Skip to main content

Completion

Struct Completion 

Source
pub struct Completion<T: Send + 'static> { /* private fields */ }
Expand description

The awaitable form of a Done declaration: what a generated <fn>_future returns.

Resolves with the arm’s answer, or with Error::Runtime when the arm returned without ever completing (the call never went out). Dropping it cancels the wait (a late completion then finds nothing) and runs the cancel hook the generated code attached, when the declaration named a cancel arm.

Implementations§

Source§

impl<T: Send + 'static> Completion<T>

Source

pub fn on_cancel(self, f: impl FnOnce() + Send + 'static) -> Self

Run f when this future is dropped before completing: the generated cancel arm.

Source

pub fn is_ready(&self) -> bool

Whether the answer has arrived.

Source

pub fn token(&self) -> u64

The token the arm was handed: what a declared cancel arm takes.

Trait Implementations§

Source§

impl<T: Send + 'static> Drop for Completion<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl<T: Send + 'static> Future for Completion<T>

Source§

type Output = Result<T, Error>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Completion<T>

§

impl<T> !Sync for Completion<T>

§

impl<T> !UnwindSafe for Completion<T>

§

impl<T> Forget for Completion<T>

§

impl<T> Freeze for Completion<T>
where Oneshot<Result<T, Error>>: Freeze, &'static Registry<T>: Freeze,

§

impl<T> Move for Completion<T>

§

impl<T> Send for Completion<T>
where Oneshot<Result<T, Error>>: Send, &'static Registry<T>: Send,

§

impl<T> Unpin for Completion<T>
where Oneshot<Result<T, Error>>: Unpin, &'static Registry<T>: Unpin,

§

impl<T> UnsafeUnpin for Completion<T>
where Oneshot<Result<T, Error>>: UnsafeUnpin, &'static Registry<T>: UnsafeUnpin,

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<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

Which kind of future are we turning this into?
Source§

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.