Skip to main content

Blocking

Struct Blocking 

Source
pub struct Blocking<T> { /* private fields */ }
Expand description

The future spawn_blocking returns: the job’s value once a pool thread has run it.

Dropping it before the job starts cancels the job, which then never runs. Dropping it while the job runs lets the job finish on its thread and discards the value: a blocking call has no way to be interrupted. Blocking::detach keeps the job without the value. Awaitable from any executor, day::task included.

Implementations§

Source§

impl<T> Blocking<T>

Source

pub fn detach(self)

Let the job run to completion without waiting for its value: for work whose effect is its own completion callback. A pooled job keeps its queue slot; an inline one runs now.

Trait Implementations§

Source§

impl<T> Drop for Blocking<T>

Available on non-WebAssembly only.
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> Future for Blocking<T>

Source§

type Output = Result<T, BlockingError>

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 Blocking<T>

§

impl<T> !Sync for Blocking<T>

§

impl<T> !UnwindSafe for Blocking<T>

§

impl<T> Freeze for Blocking<T>
where BlockingInner<T>: Freeze,

§

impl<T> Send for Blocking<T>
where BlockingInner<T>: Send,

§

impl<T> Unpin for Blocking<T>
where BlockingInner<T>: Unpin,

§

impl<T> UnsafeUnpin for Blocking<T>
where BlockingInner<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.