Skip to main content

SystemMessage

Struct SystemMessage 

Source
#[non_exhaustive]
pub struct SystemMessage { pub subtype: String, pub session_id: String, pub cwd: String, pub model: String, pub claude_code_version: String, pub permission_mode: String, pub tools: Vec<String>, pub betas: Vec<String>, pub capabilities: Vec<String>, pub skills: Vec<Value>, pub plugins: Vec<Value>, pub extra: HashMap<String, Value>, }
Expand description

Every type:"system" frame: init (first frame of each turn) plus hook_started, hook_response, compact_boundary, model_fallback, background_tasks_changed, task_started, task_updated, task_notification, thinking_tokens, model_refusal_no_fallback, peer_message_hold, … — only subtype and session_id are common to all; subtype-specific fields are in extra. Source: binary system-message schemas Source: chunk-hp1k7mph.js:194 (WGt function), chunk-20bv8pca.js:15125

Fields (Non-exhaustive)§

This struct is marked as 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.
§subtype: String

init, hook_started, compact_boundary, …

§session_id: String

Session the frame belongs to.

§cwd: String

Working directory (init).

§model: String

Active model (init).

§claude_code_version: String

CLI version (init).

§permission_mode: String

Permission mode, as its wire value (init).

§tools: Vec<String>

Available tool names (init).

§betas: Vec<String>

Enabled API betas (init).

§capabilities: Vec<String>

Protocol capabilities the CLI supports, for feature detection (init).

§skills: Vec<Value>

Loaded skills (init), kept verbatim.

§plugins: Vec<Value>

Loaded plugins (init), kept verbatim.

§extra: HashMap<String, Value>

Subtype-specific fields.

Implementations§

Source§

impl SystemMessage

Source

pub fn code_mode_active(&self) -> bool

REPL or Eval in tools[] = Code Mode active (see SessionOptions::code_mode).

Trait Implementations§

Source§

impl Clone for SystemMessage

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SystemMessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SystemMessage

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SystemMessage

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more