pub struct Stopper(/* private fields */);
Expand description

This struct provides a synchronized mechanism for canceling Futures and Streams.

Implementations§

§

impl Stopper

pub fn new() -> Stopper

Initialize a stopper that is not yet stopped and that has zero registered wakers. Any clone of this stopper represents the same internal state. This is identical to Stopper::default()

pub fn stop(&self)

Stop all futures and streams that have been registered to this Stopper or any clone representing the same initial stopper.

pub fn is_stopped(&self) -> bool

Returns whether this stopper (or any clone of it) has been stopped.

Example
let stopper = stopper::Stopper::new();
assert!(!stopper.is_stopped());
stopper.stop();
assert!(stopper.is_stopped());

pub fn stop_stream<S>(&self, stream: S) -> StreamStopper<S>
where S: Stream,

This function returns a new stream which will poll None (indicating a completed stream) when this Stopper has been stopped. The Stream’s Item is unchanged.

Example
use futures_lite::StreamExt;
let stopper = stopper::Stopper::new();
let mut stream = stopper.stop_stream(futures_lite::stream::repeat("infinite stream"));

std::thread::spawn(move || {
    std::thread::sleep(std::time::Duration::from_secs(1));
    stopper.stop();
});

while let Some(item) = stream.next().await {
    println!("{}", item);
}

pub fn stop_future<F>(&self, future: F) -> FutureStopper<F>
where F: Future,

This function returns a Future which wraps the provided future and stops it when this Stopper has been stopped. Note that the Output of the returned future is wrapped with an Option. If the future resolves to None, that indicates that it was stopped instead of polling to completion.

Example
let stopper = stopper::Stopper::new();
let mut future = stopper.stop_future(std::future::pending::<()>());

std::thread::spawn(move || {
    std::thread::sleep(std::time::Duration::from_secs(1));
    stopper.stop();
});

assert_eq!(future.await, None);

Trait Implementations§

§

impl Clone for Stopper

§

fn clone(&self) -> Stopper

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl Debug for Stopper

§

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

Formats the value using the given formatter. Read more
§

impl Default for Stopper

§

fn default() -> Stopper

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.