Struct ShutdownRequest 

pub struct ShutdownRequest {
    pub detach_session_end_hooks: Option<bool>,
    pub reason: Option<String>,
    pub type: Option<ShutdownType>,
}

Parameters for shutting down the session

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

detach_session_end_hooks: Option<bool>

Dispatch deferred sessionEnd hooks in the background with their full per-hook timeoutSec instead of awaiting them under the short shared shutdown budget. Set this when the host process keeps running after the session closes (for example the CLI’s /clear), so a slow hook neither blocks the close nor is aborted. Hooks still detached when the process later exits are terminated with it. Defaults to false.

reason: Option<String>

Optional human-readable reason. Typically the message of the error that triggered shutdown when type is ‘error’.

type: Option<ShutdownType>

Why the session is being shut down. Defaults to “routine” when omitted.

Trait Implementations

impl Clone for ShutdownRequest

fn clone(&self) -> ShutdownRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownRequest

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

Formats the value using the given formatter.

impl Default for ShutdownRequest

fn default() -> ShutdownRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShutdownRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ShutdownRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.