Struct Shutdown 

pub struct Shutdown { /* private fields */ }

The receiving half of a shutdown signal, handed to crate::Bot::run_until

Implementations

impl Shutdown

pub fn channel() -> (ShutdownSignal, Self)

Create a linked signal/receiver pair

pub fn never() -> Self

A shutdown that never fires, for bots meant to run until the process exits

pub fn is_shutdown(&self) -> bool

Whether shutdown has already been requested

pub async fn wait(&self)

Resolve once shutdown is requested

Never resolves for Shutdown::never, so it is safe to select on unconditionally.

Trait Implementations

impl Clone for Shutdown

fn clone(&self) -> Shutdown

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Shutdown

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

Formats the value using the given formatter.

impl Default for Shutdown

fn default() -> Self

Returns the “default value” for a type.