Struct stream_cancel::Tripwire

pub struct Tripwire { /* fields omitted */ }

A Tripwire is a convenient mechanism for implementing graceful shutdown over many asynchronous streams. A Tripwire is a Future that is Clone, and that can be passed to StreamExt::take_until_if. All Tripwire clones are associated with a single Trigger, which is then used to signal that all the associated streams should be terminated.

The Tripwire future resolves to true if the stream should be considered closed, and false if the Trigger has been disabled.

Tripwire is internally implemented using a Shared<oneshot::Receiver<()>>, with the Trigger holding the associated oneshot::Sender. There is very little magic.

Implementations

impl Tripwire

pub fn new() -> (Trigger, Self)

Make a new Tripwire and an associated Trigger.

Trait Implementations

impl Clone for Tripwire

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tripwire

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

Formats the value using the given formatter.

impl Future for Tripwire

type Output = bool

The type of value produced on completion.

pub fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<'pin> Unpin for Tripwire where
    __Tripwire<'pin>: Unpin,