Struct Shutdown 

pub struct Shutdown {
    pub busy: bool,
    pub done: bool,
    pub error: bool,
    pub error_message: String,
    /* private fields */
}

Fields

busy: bool

true while waiting for a response from the server.

done: bool

true for one cycle after the server confirms the command.

error: bool

true for one cycle after the server returns an error.

error_message: String

Error description from the server (empty when no error).

Implementations

impl Shutdown

pub fn new() -> Self

Creates a new shutdown controller in the idle state.

pub fn initiate(&mut self, client: &mut CommandClient)

Send a system.full_shutdown command to the server.

Does nothing if an operation is already in progress (busy is true). The server will schedule a shutdown with a 15-second delay.

pub fn cancel(&mut self, client: &mut CommandClient)

Send a system.cancel_full_shutdown command to the server.

Does nothing if an operation is already in progress (busy is true).

pub fn call(&mut self, client: &mut CommandClient)

Poll for the server response. Call this once per scan cycle.

Updates busy, done, error, and error_message based on whether a response has arrived.

pub fn is_initiating(&self) -> bool

Returns true if a shutdown initiation is currently pending.

pub fn is_cancelling(&self) -> bool

Returns true if a shutdown cancellation is currently pending.

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.