Struct SessionRpc 

pub struct SessionRpc<'a> { /* private fields */ }

Typed view over a Session’s RPC namespace.

Implementations

impl<'a> SessionRpc<'a>

pub fn agent(&self) -> SessionRpcAgent<'a>

session.agent.* sub-namespace.

pub fn auth(&self) -> SessionRpcAuth<'a>

session.auth.* sub-namespace.

pub fn commands(&self) -> SessionRpcCommands<'a>

session.commands.* sub-namespace.

pub fn event_log(&self) -> SessionRpcEventLog<'a>

session.eventLog.* sub-namespace.

pub fn extensions(&self) -> SessionRpcExtensions<'a>

session.extensions.* sub-namespace.

pub fn fleet(&self) -> SessionRpcFleet<'a>

session.fleet.* sub-namespace.

pub fn history(&self) -> SessionRpcHistory<'a>

session.history.* sub-namespace.

pub fn instructions(&self) -> SessionRpcInstructions<'a>

session.instructions.* sub-namespace.

pub fn lsp(&self) -> SessionRpcLsp<'a>

session.lsp.* sub-namespace.

pub fn mcp(&self) -> SessionRpcMcp<'a>

session.mcp.* sub-namespace.

pub fn metadata(&self) -> SessionRpcMetadata<'a>

session.metadata.* sub-namespace.

pub fn mode(&self) -> SessionRpcMode<'a>

session.mode.* sub-namespace.

pub fn model(&self) -> SessionRpcModel<'a>

session.model.* sub-namespace.

pub fn name(&self) -> SessionRpcName<'a>

session.name.* sub-namespace.

pub fn options(&self) -> SessionRpcOptions<'a>

session.options.* sub-namespace.

pub fn permissions(&self) -> SessionRpcPermissions<'a>

session.permissions.* sub-namespace.

pub fn plan(&self) -> SessionRpcPlan<'a>

session.plan.* sub-namespace.

pub fn plugins(&self) -> SessionRpcPlugins<'a>

session.plugins.* sub-namespace.

pub fn queue(&self) -> SessionRpcQueue<'a>

session.queue.* sub-namespace.

pub fn remote(&self) -> SessionRpcRemote<'a>

session.remote.* sub-namespace.

pub fn schedule(&self) -> SessionRpcSchedule<'a>

session.schedule.* sub-namespace.

pub fn shell(&self) -> SessionRpcShell<'a>

session.shell.* sub-namespace.

pub fn skills(&self) -> SessionRpcSkills<'a>

session.skills.* sub-namespace.

pub fn tasks(&self) -> SessionRpcTasks<'a>

session.tasks.* sub-namespace.

pub fn telemetry(&self) -> SessionRpcTelemetry<'a>

session.telemetry.* sub-namespace.

pub fn tools(&self) -> SessionRpcTools<'a>

session.tools.* sub-namespace.

pub fn ui(&self) -> SessionRpcUi<'a>

session.ui.* sub-namespace.

pub fn usage(&self) -> SessionRpcUsage<'a>

session.usage.* sub-namespace.

pub fn workspaces(&self) -> SessionRpcWorkspaces<'a>

session.workspaces.* sub-namespace.

pub async fn suspend(&self) -> Result<(), Error>

Suspends the session while preserving persisted state for later resume.

Wire method: session.suspend.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

pub async fn send(&self, params: SendRequest) -> Result<SendResult, Error>

Sends a user message to the session and returns its message ID.

Wire method: session.send.

Parameters

• params - Parameters for sending a user message to the session

Returns

Result of sending a user message

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

pub async fn abort(&self, params: AbortRequest) -> Result<AbortResult, Error>

Aborts the current agent turn.

Wire method: session.abort.

Parameters

• params - Parameters for aborting the current turn

Returns

Result of aborting the current turn

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

pub async fn shutdown(&self, params: ShutdownRequest) -> Result<(), Error>

Shuts down the session and persists its final state. Awaits any deferred sessionEnd hooks before resolving so user-supplied hook scripts complete before the runtime tears down.

Wire method: session.shutdown.

Parameters

• params - Parameters for shutting down the session

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

pub async fn log(&self, params: LogRequest) -> Result<LogResult, Error>

Emits a user-visible session log event.

Wire method: session.log.

Parameters

• params - Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip.

Returns

Identifier of the session event that was emitted for the log message.

Experimental. This API is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases. Pin both the SDK and CLI versions if your code depends on it.

Trait Implementations

impl<'a> Clone for SessionRpc<'a>

fn clone(&self) -> SessionRpc<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for SessionRpc<'a>