Struct Session

Source

pub struct Session {
    pub session_id: String,
    pub cwd: PathBuf,
    /* private fields */
}

Expand description

An active Claude session

Each session holds its own ClaudeClient instance and maintains independent state for usage tracking, permissions, and message conversion.

Fields§

§session_id: String

Unique session identifier

§cwd: PathBuf

Working directory for this session

Implementations§

Source §

impl Session

Source

pub fn new( session_id: String, cwd: PathBuf, config: &AgentConfig, meta: Option<&NewSessionMeta>, ) -> Result<Arc<Self>>

Create a new session and wrap in Arc

Returns Arc because the can_use_tool callback needs Arc. We use OnceLock to break the circular dependency between Session and callback.

§Arguments

session_id - Unique identifier for this session
cwd - Working directory
config - Agent configuration from environment
meta - Session metadata from the new session request

Source

pub fn set_external_mcp_servers(&self, servers: Vec<McpServer>)

Set external MCP servers to connect

§Arguments

servers - List of MCP servers from the client request

Source

pub fn set_connection_cx(&self, cx: JrConnectionCx<AgentToClient>)

Set the connection context for ACP requests

This is called once during handle_prompt to enable permission requests. The OnceLock ensures it’s only set once even if called multiple times.

Source

pub fn get_connection_cx(&self) -> Option<&JrConnectionCx<AgentToClient>>

Get the connection context if available

Returns None if called before handle_prompt sets the connection.

Source

pub fn cache_permission(&self, tool_input: &Value, allowed: bool)

Cache a permission result for a tool_input

Called by PreToolUse hook after user grants permission. The can_use_tool callback checks this cache before sending permission requests.

Source

pub fn check_cached_permission(&self, tool_input: &Value) -> Option<bool>

Check if a tool_input has cached permission

Called by can_use_tool callback to check if permission was already granted. Returns Some(true) if allowed, Some(false) if denied, None if not cached. Removes the entry from cache after retrieval (one-time use).

Source

pub fn permission_cache(&self) -> Arc<DashMap<String, bool>>

Get a reference to the permission_cache for sharing with hooks

Source

pub fn cache_tool_use_id(&self, tool_input: &Value, tool_use_id: &str)

Cache tool_use_id for a tool_input

Called by PreToolUse hook when Ask decision is made. The can_use_tool callback uses this to get tool_use_id when CLI doesn’t provide it.

Source

pub fn get_cached_tool_use_id(&self, tool_input: &Value) -> Option<String>

Get cached tool_use_id for a tool_input

Called by can_use_tool callback to get tool_use_id when CLI doesn’t provide it. Returns the tool_use_id if cached, None otherwise. Removes the entry from cache after retrieval (one-time use).

Source

pub fn tool_use_id_cache(&self) -> Arc<DashMap<String, String>>

Get a reference to the tool_use_id_cache for sharing with hooks

Source

pub async fn connect_external_mcp_servers(&self) -> Result<()>

Connect to external MCP servers

This should be called before the first prompt to ensure all external MCP tools are available.

Source

pub async fn connect(&self) -> Result<()>

Connect to Claude CLI

This spawns the Claude CLI process and establishes JSON-RPC communication.

Source

pub async fn disconnect(&self) -> Result<()>

Disconnect from Claude CLI

Source

pub fn is_connected(&self) -> bool

Check if the session is connected

Source

pub async fn client(&self) -> RwLockReadGuard<'_, ClaudeClient>

Get read access to the client

Source

pub async fn client_mut(&self) -> RwLockWriteGuard<'_, ClaudeClient>

Get write access to the client

Source

pub fn cancel_receiver(&self) -> Receiver<()>

Get a receiver for cancel signals

This can be used to listen for MCP cancellation notifications. When a cancel notification is received, a signal is sent through the channel.

Source

pub async fn cancel(&self)

Cancel this session and interrupt the Claude CLI

This sends an interrupt signal to the Claude CLI to stop the current operation. Note: This does NOT use a cancelled flag anymore - cancellation is handled per-prompt via CancellationToken in the PromptManager.

Source

pub async fn permission(&self) -> RwLockReadGuard<'_, PermissionHandler>

Get the permission handler

Source

pub async fn permission_mode(&self) -> PermissionMode

Get the current permission mode

Source

pub async fn set_permission_mode(&self, mode: PermissionMode)

Set the permission mode

Updates the PermissionHandler. The hook will read the mode from the same PermissionHandler, ensuring consistency.

Source

pub fn send_mode_update(&self, mode: &str)

Send session/update notification for permission mode change

This sends a CurrentModeUpdate notification to the client to inform it that the permission mode has changed. This is used for ExitPlanMode to notify the UI that the mode has been switched.

Source