Struct Session 

pub struct Session {

    pub id: SessionId,
    pub parent_id: Option<SessionId>,
    pub session_type: SessionType,
    pub tenant_id: Option<String>,
    pub mode: SessionMode,
    pub state: SessionState,
    pub config: SessionConfig,
    pub permission_policy: PermissionPolicy,
    pub messages: Vec<SessionMessage>,
    pub current_leaf_id: Option<MessageId>,
    pub summary: Option<String>,
    pub total_usage: TokenUsage,
    pub current_input_tokens: u64,
    pub total_cost_usd: f64,
    pub static_context_hash: Option<String>,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
    pub expires_at: Option<DateTime<Utc>>,
    pub error: Option<String>,
    pub todos: Vec<TodoItem>,
    pub current_plan: Option<Plan>,
    pub compact_history: Vec<CompactRecord>,
}

Fields

id: SessionId

parent_id: Option<SessionId>

session_type: SessionType

tenant_id: Option<String>

mode: SessionMode

state: SessionState

config: SessionConfig

permission_policy: PermissionPolicy

messages: Vec<SessionMessage>

current_leaf_id: Option<MessageId>

summary: Option<String>

total_usage: TokenUsage

current_input_tokens: u64

total_cost_usd: f64

static_context_hash: Option<String>

created_at: DateTime<Utc>

updated_at: DateTime<Utc>

expires_at: Option<DateTime<Utc>>

error: Option<String>

todos: Vec<TodoItem>

current_plan: Option<Plan>

compact_history: Vec<CompactRecord>

Implementations

impl Session

pub fn new(config: SessionConfig) -> Self

pub fn with_id(id: SessionId, config: SessionConfig) -> Self

pub fn new_subagent( parent_id: SessionId, agent_type: impl Into<String>, description: impl Into<String>, config: SessionConfig, ) -> Self

pub fn is_subagent(&self) -> bool

pub fn is_running(&self) -> bool

pub fn is_terminal(&self) -> bool

pub fn is_expired(&self) -> bool

pub fn add_message(&mut self, message: SessionMessage)

pub fn get_current_branch(&self) -> Vec<&SessionMessage>

pub fn to_api_messages(&self) -> Vec<Message>

Convert session messages to API format with default caching (5m TTL).

pub fn to_api_messages_with_cache(&self, ttl: Option<CacheTtl>) -> Vec<Message>

Convert session messages to API format with optional caching.

Per Anthropic best practices, caches the last user message with the specified TTL. Pass None to disable caching.

pub fn branch_length(&self) -> usize

pub fn set_state(&mut self, state: SessionState)

pub fn set_todos(&mut self, todos: Vec<TodoItem>)

pub fn todos_in_progress_count(&self) -> usize

pub fn enter_plan_mode(&mut self, name: Option<String>) -> &Plan

pub fn update_plan_content(&mut self, content: String)

pub fn exit_plan_mode(&mut self) -> Option<Plan>

pub fn cancel_plan(&mut self) -> Option<Plan>

pub fn is_in_plan_mode(&self) -> bool

pub fn record_compact(&mut self, record: CompactRecord)

pub fn update_summary(&mut self, summary: impl Into<String>)

pub fn add_user_message(&mut self, content: impl Into<String>)

pub fn add_assistant_message( &mut self, content: Vec<ContentBlock>, usage: Option<Usage>, )

pub fn add_tool_results(&mut self, results: Vec<ToolResultBlock>)

pub fn current_tokens(&self) -> u64

pub fn should_compact( &self, max_tokens: u64, threshold: f32, keep_messages: usize, ) -> bool

pub fn update_usage(&mut self, usage: &Usage)

pub async fn compact( &mut self, client: &Client, keep_messages: usize, ) -> Result<CompactResult>

pub fn clear_messages(&mut self)

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Session

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Session

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

where __S: Serializer,

Serialize this value into the given Serde serializer.