Struct allochronic_util::Yield[][src]

#[must_use = "futures do nothing unless you `.await` or poll them"]pub struct Yield(_);

Yields to the executor once. See yield for easier usage.

Examples

use std::task::Poll;

use allochronic_util::{poll, Yield};

let mut future = async {
	Yield::new().await;
	1
};
futures_util::pin_mut!(future);

assert_eq!(Poll::Pending, poll(&mut future).await);
assert_eq!(Poll::Ready(1), poll(future).await);

Implementations

impl Yield[src]

pub const fn new() -> Self[src]

Builds a new Yield.

Trait Implementations

impl Debug for Yield[src]

impl Future for Yield[src]

type Output = ()

The type of value produced on completion.

Auto Trait Implementations

impl RefUnwindSafe for Yield

impl Send for Yield

impl Sync for Yield

impl Unpin for Yield

impl UnwindSafe for Yield

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> FutureExt for T where
    T: Future + ?Sized
[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<F> IntoFuture for F where
    F: Future
[src]

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.