Struct relay_system::Shutdown

pub struct Shutdown {
    pub timeout: Option<Duration>,
}

Shutdown request message sent by the Controller to subscribed services.

A handler has to ensure that it doesn’t take longer than timeout to resolve the future. Ideally, open work is persisted or finished in an orderly manner but no new requests are accepted anymore.

After the timeout the system will shut down regardless of what the receivers of this message do.

The return value is fully ignored. It is only Result such that futures can be executed inside a handler.

Fields

timeout: Option<Duration>

The timeout for this shutdown. None indicates an immediate forced shutdown.

Trait Implementations

impl Clone for Shutdown

fn clone(&self) -> Shutdown

Returns a copy 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.