Struct std::task::ContextBuilder

source ·
pub struct ContextBuilder<'a> { /* private fields */ }
🔬This is a nightly-only experimental API. (local_waker #118959)
Expand description

A Builder used to construct a Context instance with support for LocalWaker.

§Examples

#![feature(local_waker)]
#![feature(noop_waker)]
use std::task::{ContextBuilder, LocalWaker, Waker, Poll};
use std::future::Future;

let local_waker = LocalWaker::noop();
let waker = Waker::noop();

let mut cx = ContextBuilder::from_waker(&waker)
    .local_waker(&local_waker)
    .build();

let mut future = std::pin::pin!(async { 20 });
let poll = future.as_mut().poll(&mut cx);
assert_eq!(poll, Poll::Ready(20));
Run

Implementations§

source§

impl<'a> ContextBuilder<'a>

const: unstable · source

pub fn from_waker(waker: &'a Waker) -> ContextBuilder<'a>

🔬This is a nightly-only experimental API. (local_waker #118959)

Create a ContextBuilder from a Waker.

const: unstable · source

pub fn from(cx: &'a mut Context<'_>) -> ContextBuilder<'a>

🔬This is a nightly-only experimental API. (context_ext #123392)

Create a ContextBuilder from an existing Context.

const: unstable · source

pub fn waker(self, waker: &'a Waker) -> ContextBuilder<'a>

🔬This is a nightly-only experimental API. (context_ext #123392)

This method is used to set the value for the waker on Context.

const: unstable · source

pub fn local_waker(self, local_waker: &'a LocalWaker) -> ContextBuilder<'a>

🔬This is a nightly-only experimental API. (local_waker #118959)

This method is used to set the value for the local waker on Context.

const: unstable · source

pub fn ext(self, data: &'a mut (dyn Any + 'static)) -> ContextBuilder<'a>

🔬This is a nightly-only experimental API. (context_ext #123392)

This method is used to set the value for the extension data on Context.

const: unstable · source

pub fn build(self) -> Context<'a>

🔬This is a nightly-only experimental API. (local_waker #118959)

Builds the Context.

Trait Implementations§

source§

impl<'a> Debug for ContextBuilder<'a>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for ContextBuilder<'a>

§

impl<'a> !RefUnwindSafe for ContextBuilder<'a>

§

impl<'a> !Send for ContextBuilder<'a>

§

impl<'a> !Sync for ContextBuilder<'a>

§

impl<'a> Unpin for ContextBuilder<'a>

§

impl<'a> !UnwindSafe for ContextBuilder<'a>

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

§

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

§

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.