Struct Tripwire 

pub struct Tripwire { /* private fields */ }

A Future that completes once the program is requested to shutdown. This gives a chance for other Futures to do additional cleanup before being dropped.

Implementations

impl Tripwire

pub fn new<S>(stream: S) -> (Self, TripwireWorker<S>)

where S: Stream<Item = ()>,

Create a new Tripwire. The returned worker will trip the tripwire when dropped, and must be spawned on a runtime to listen for SIGTERM/SIGINT

pub fn new_simple() -> (Self, TripwireWorker<ReceiverStream<()>>, Sender<()>)

Create a new Tripwire listens for a () being sent to the returned sender. Graceful shutdown can then be awaited through the TripwireWorker

pub fn new_signals() -> (Self, TripwireWorker<Select<SignalStream, SignalStream>>)

Listen for SIGTERM and SIGINT

pub fn state(&self) -> TripwireState

Returns an Arc of the current TripwireState

pub fn is_shutting_down(&self) -> bool

Returns true if we’re shutting down

pub fn tripwired<F>(self, inner: F) -> Tripwired<F>

Returns a Future that completes when this wire is tripped

Trait Implementations

impl Clone for Tripwire

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tripwire

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

Formats the value using the given formatter.

impl Future for Tripwire

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.