Struct SuspendedJobsGuardConfig 

#[non_exhaustive]
pub struct SuspendedJobsGuardConfig {
    pub message: String,
}

Configuration for the suspended-jobs exit guard.

When present in Env::any, EofGuard refuses to exit when there are suspended jobs, printing message to warn the user. Other components may also opt in to this protection by checking for this config.

Store this config in the environment with env.any.insert(Box::new(config)).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

message: String

Text displayed when exit is prevented because there are suspended jobs

Implementations

impl SuspendedJobsGuardConfig

pub fn with_message<M: Into<String>>(message: M) -> Self

Creates a new SuspendedJobsGuardConfig with the given message.

Trait Implementations

impl Clone for SuspendedJobsGuardConfig

fn clone(&self) -> SuspendedJobsGuardConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SuspendedJobsGuardConfig

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

Formats the value using the given formatter.

impl Default for SuspendedJobsGuardConfig

fn default() -> SuspendedJobsGuardConfig

Returns the “default value” for a type.