Struct Shutdown

pub struct Shutdown { /* private fields */ }

The Shutdown struct listens for the signal and tracks that the signal has been received. Callers may query for whether the shutdown signal has been received or not.

Implementations

impl Shutdown

pub fn new(notify: Sender<()>) -> Shutdown

Create a new Shutdown backed by the given broadcast::Receiver.

pub fn is_shutdown(&self) -> bool

Returns true if the shutdown signal has been received.

pub async fn recv(&mut self)

Receive the shutdown notice, waiting if necessary.

pub fn broadcast_shutdown(&mut self)

Trait Implementations

impl Clone for Shutdown

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Shutdown

fn default() -> Self

Returns the “default value” for a type.