Struct StopListener 

pub struct StopListener { /* private fields */ }

StopListener should be incorporated into each user-defined task. It Derefs to a channel receiver which can be awaited. When resolved, the task should shut itself down.

When the StopListener is dropped, that signals the TaskManager that the task has ended.

Implementations

impl StopListener

pub fn fuse_with<T, S: Unpin + Stream<Item = T>>( self, stream: S, ) -> Fuse<Pin<Box<StopListenerFuse<T, S>>>>

Modify a stream so that when the StopListener resolves, the stream is fused and ends.

pub fn receiver(&mut self) -> &mut Receiver<()>

Accessor for the underlying oneshot receiver

pub fn ready(&mut self) -> bool

Returns false if the oneshot message has not yet been sent. Returns true if the message was sent or the channel canceled/dropped.

Trait Implementations

impl Drop for StopListener

fn drop(&mut self)

Executes the destructor for this type.

impl Future for StopListener

type Output = ()

The type of value produced on completion.

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.