Struct cassette::Cassette

source ·
pub struct Cassette<T>
where T: Future + Unpin,
{ /* private fields */ }
Expand description

A single-future non-blocking executor

Implementations§

source§

impl<T> Cassette<T>
where T: Future + Unpin,

source

pub fn new(thing: T) -> Self

Create a new Cassette containing a single pinned future

§Example
use cassette::Cassette;

struct Demo {
    lol: u32,
}

impl Demo {
    async fn entry(&mut self) {
        /* Huzzah! */
    }
}

// Make a new struct
let mut demo = Demo { lol: 100 };

// Call the entry point future, and pin it
let x = core::pin::pin!(demo.entry());

// Give the pinned future to Cassette
// for execution
let mut cm = Cassette::new(x);
source

pub fn poll_on(&mut self) -> Option<<T as Future>::Output>

Perform a “single step” of the future contained by this Cassette.

This is intended to be “polled to completion”, which might be for forever.

§Example
use cassette::Cassette;

struct Demo {
    lol: u32,
}

impl Demo {
    async fn entry(&mut self) {
        /* Huzzah! */
    }
}

// Make a new struct
let mut demo = Demo { lol: 100 };

// Call the entry point future, and pin it
let x = core::pin::pin!(demo.entry());

// Give the pinned future to Cassette
// for execution
let mut cm = Cassette::new(x);

while cm.poll_on().is_none() { }
println!("Future done!");
§Panics

This method will panic if the contained future has already been completed as Poll::Ready(_).

source

pub fn block_on(self) -> <T as Future>::Output

Block on the contained future forever

§Panics

This method will panic if the contained future has already been completed as Poll::Ready(_).

source

pub fn is_done(&self) -> bool

Has the contained future resolved to Poll::Ready(_) yet?

Auto Trait Implementations§

§

impl<T> Freeze for Cassette<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Cassette<T>
where T: RefUnwindSafe,

§

impl<T> Send for Cassette<T>
where T: Send,

§

impl<T> Sync for Cassette<T>
where T: Sync,

§

impl<T> Unpin for Cassette<T>

§

impl<T> UnwindSafe for Cassette<T>
where T: UnwindSafe,

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.