Enum pavex::server::ShutdownMode

#[non_exhaustive]
pub enum ShutdownMode {
    Graceful {
        timeout: Duration,
    },
    Forced,
}

Determine how a running Server should shut down.

Use ServerHandle::shutdown to initiate the shutdown sequence.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Graceful

Wait for each worker thread to finish handling its open connections before shutting down.

Fields

timeout: Duration

As much as we want to be graceful, we can’t wait forever!
Any connection that has not been handled within the specified timeout will be dropped.

Forced

Shut down immediately, dropping all open connections abruptly.

Implementations

impl ShutdownMode

pub fn is_graceful(&self) -> bool

Returns true if you are asking for a graceful shutdown.

pub fn is_forced(&self) -> bool

Returns true if you are asking for a forced shutdown.

Trait Implementations

impl Clone for ShutdownMode

fn clone(&self) -> ShutdownMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownMode

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

Formats the value using the given formatter.