Struct SessionMetadataSnapshotResult 

pub struct SessionMetadataSnapshotResult {

    pub already_in_use: bool,
    pub client_name: Option<String>,
    pub current_mode: MetadataSnapshotCurrentMode,
    pub initial_name: Option<String>,
    pub is_remote: bool,
    pub modified_time: String,
    pub remote_metadata: Option<MetadataSnapshotRemoteMetadata>,
    pub selected_model: Option<String>,
    pub session_id: SessionId,
    pub start_time: String,
    pub summary: Option<String>,
    pub working_directory: String,
    pub workspace: Option<SessionMetadataSnapshotResultWorkspace>,
    pub workspace_path: Option<String>,
}

Point-in-time snapshot of slow-changing session identifier and state fields

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

Fields

already_in_use: bool

True when the session was detected to be in use by another process at construction time. Local consumers may surface a confirmation prompt before fully attaching. Always false for new sessions.

client_name: Option<String>

Runtime client name associated with the session (telemetry identifier).

current_mode: MetadataSnapshotCurrentMode

The current agent mode for this session (e.g., ‘interactive’, ‘plan’, ‘autopilot’)

initial_name: Option<String>

User-provided name supplied at session construction (via --name), if any. Immutable after construction.

is_remote: bool

Whether this is a remote session (i.e., one whose runtime executes elsewhere and is steered through this process)

modified_time: String

ISO 8601 timestamp of when the session’s persisted state was last modified on disk. For new sessions, equals startTime. For resumed sessions, reflects the previous modification time at construction.

remote_metadata: Option<MetadataSnapshotRemoteMetadata>

Remote-session-specific metadata. Populated only when isRemote is true. Fields are immutable for the lifetime of the session.

selected_model: Option<String>

Currently selected model identifier, if any

session_id: SessionId

The unique identifier of the session

start_time: String

ISO 8601 timestamp of when the session started

summary: Option<String>

Short human-readable summary of the session, if known. Omitted when no summary has been generated.

working_directory: String

Absolute path to the session’s current working directory

workspace: Option<SessionMetadataSnapshotResultWorkspace>

Public-facing workspace metadata for this session, or null if the session has no associated workspace. Excludes runtime-internal fields (GitHub IDs, summary count, internal flags).

workspace_path: Option<String>

Absolute path to the session’s workspace directory on disk, or null if the session has no associated workspace

Trait Implementations

impl Clone for SessionMetadataSnapshotResult

fn clone(&self) -> SessionMetadataSnapshotResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionMetadataSnapshotResult

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

Formats the value using the given formatter.

impl Default for SessionMetadataSnapshotResult

fn default() -> SessionMetadataSnapshotResult

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionMetadataSnapshotResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SessionMetadataSnapshotResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.