[−][src]Struct stream_cancel::Tripwire
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. 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.
Methods
impl Tripwire[src]
Trait Implementations
impl Clone for Tripwire[src]
ⓘImportant traits for Tripwirefn clone(&self) -> Tripwire[src]
fn clone_from(&mut self, source: &Self)1.0.0[src]
impl Debug for Tripwire[src]
impl Future for Tripwire[src]
type Output = bool
The type of value produced on completion.
fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>[src]
impl<'pin> Unpin for Tripwire where
__Tripwire<'pin>: Unpin, [src]
__Tripwire<'pin>: Unpin,
Auto Trait Implementations
impl !RefUnwindSafe for Tripwire
impl Send for Tripwire
impl Sync for Tripwire
impl !UnwindSafe for Tripwire
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T> FutureExt for T where
T: Future + ?Sized, [src]
T: Future + ?Sized,
fn map<U, F>(self, f: F) -> Map<Self, F> where
F: FnOnce(Self::Output) -> U, [src]
F: FnOnce(Self::Output) -> U,
fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
F: FnOnce(Self::Output) -> Fut,
Fut: Future, [src]
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
fn left_future<B>(self) -> Either<Self, B> where
B: Future<Output = Self::Output>, [src]
B: Future<Output = Self::Output>,
fn right_future<A>(self) -> Either<A, Self> where
A: Future<Output = Self::Output>, [src]
A: Future<Output = Self::Output>,
fn into_stream(self) -> IntoStream<Self>[src]
fn flatten(self) -> Flatten<Self> where
Self::Output: Future, [src]
Self::Output: Future,
fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream, [src]
Self::Output: Stream,
fn fuse(self) -> Fuse<Self>[src]
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnOnce(&Self::Output), [src]
F: FnOnce(&Self::Output),
fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe, [src]
Self: UnwindSafe,
fn shared(self) -> Shared<Self> where
Self::Output: Clone, [src]
Self::Output: Clone,
fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)[src]
fn boxed<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send>> where
Self: Send + 'a, [src]
Self: Send + 'a,
fn boxed_local<'a>(self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a>> where
Self: 'a, [src]
Self: 'a,
fn unit_error(self) -> UnitError<Self>[src]
fn never_error(self) -> NeverError<Self>[src]
fn poll_unpin(&mut self, cx: &mut Context) -> Poll<Self::Output> where
Self: Unpin, [src]
Self: Unpin,
fn now_or_never(self) -> Option<Self::Output>[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T[src]
fn clone_into(&self, target: &mut T)[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,