Skip to main content

Pending

Struct Pending 

Source
pub struct Pending<'a, T> { /* private fields */ }
Expand description

Pending is a decode result on its way.

It is a Future: .await it on any single-threaded executor, or wrap it so its waker also wakes an event loop. A host that runs a frame loop instead calls try_take once a frame. Dropping a Pending cancels the work if it has not started.

The lifetime is what a frame borrows from its Codec: opening an image answers a Pending<'static, _>, while a frame keeps the codec borrowed until it arrives, so one codec cannot be decoding two frames at once.

The type is !Send on purpose: the inline loader runs the decode inside poll, on the polling thread, and an opened codec belongs to that thread too.

Implementations§

Source§

impl<'a, T> Pending<'a, T>

Source

pub fn try_take(&mut self) -> Option<Result<T, DecodeError>>

try_take returns the result if it is ready, without blocking.

With an inline loader the first call does the decode. Returns None while a worker is still busy.

§Panics

Panics if called again after it returned Some.

Trait Implementations§

Source§

impl<T> Debug for Pending<'_, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Future for Pending<'_, T>

Source§

type Output = Result<T, DecodeError>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, context: &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<'a, T> !RefUnwindSafe for Pending<'a, T>

§

impl<'a, T> !Send for Pending<'a, T>

§

impl<'a, T> !Sync for Pending<'a, T>

§

impl<'a, T> !UnwindSafe for Pending<'a, T>

§

impl<'a, T> Freeze for Pending<'a, T>
where Option<Pin<Box<dyn Future<Output = Result<T, DecodeError>> + 'a>>>: Freeze,

§

impl<'a, T> Unpin for Pending<'a, T>
where Option<Pin<Box<dyn Future<Output = Result<T, DecodeError>> + 'a>>>: Unpin,

§

impl<'a, T> UnsafeUnpin for Pending<'a, T>
where Option<Pin<Box<dyn Future<Output = Result<T, DecodeError>> + 'a>>>: 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<F, T, E> TryFuture for F
where F: Future<Output = Result<T, E>> + ?Sized,

Source§

type Ok = T

The type of successful values yielded by this future
Source§

type Error = E

The type of failures yielded by this future
Source§

fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>, ) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more
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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>