Struct stream_cancel::Trigger

pub struct Trigger(_);

A handle to a set of cancellable streams.

If the Trigger is dropped, any streams associated with it are interrupted (this is equivalent to calling [Trigger::close]. To override this behavior, call Trigger::disable.

Implementations

impl Trigger

pub fn cancel(self)

Cancel all associated streams, and make them immediately yield None.

pub fn disable(self)

Disable the Trigger, and leave all associated streams running to completion.

Trait Implementations

impl Debug for Trigger

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

Formats the value using the given formatter.

impl Drop for Trigger

fn drop(&mut self)

Executes the destructor for this type.