Struct SDKControlInterruptRequest 

pub struct SDKControlInterruptRequest { /* private fields */ }

SDK control message to gracefully interrupt a running Claude session.

When written to the CLI subprocess’s stdin, this tells Claude to stop its current response and return control to the caller without killing the session.

This corresponds to the TypeScript SDK’s SDKControlInterruptRequest type and is distinct from closing or aborting the subprocess.

Example

use claude_codes::SDKControlInterruptRequest;

let interrupt = SDKControlInterruptRequest::new();
let json = serde_json::to_string(&interrupt).unwrap();
assert_eq!(json, r#"{"subtype":"interrupt"}"#);

Implementations

impl SDKControlInterruptRequest

pub fn new() -> Self

Create a new interrupt request.

Trait Implementations

impl Clone for SDKControlInterruptRequest

fn clone(&self) -> SDKControlInterruptRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SDKControlInterruptRequest

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

Formats the value using the given formatter.

impl Default for SDKControlInterruptRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SDKControlInterruptRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SDKControlInterruptRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.