Struct RpcClient 

pub struct RpcClient { /* private fields */ }

Typed RPC client. Cheap to clone.

Implementations

impl RpcClient

pub fn connect(transport: Transport) -> Result<Self, ClientError>

Connects over transport.

Errors

The child could not be spawned.

pub fn from_io<R, W>(reader: R, writer: W) -> Self

where R: AsyncRead + Unpin + Send + 'static, W: AsyncWrite + Unpin + Send + 'static,

A client over an already connected byte stream pair.

pub fn events(&self) -> BoxStream<'static, JsonValue>

Raw wire events (everything that is not a reply to this client), from now on.

pub async fn request( &self, command: RpcCommand, ) -> Result<RpcResponseData, ClientError>

Sends any command and waits for its reply.

Errors

ClientError::Command with the server’s error text, ClientError::Closed when the server went away.

pub async fn ui_respond(&self, response: &UiResponse) -> Result<(), ClientError>

Answers a dialog.

Errors

The write failed.

pub async fn close(&self) -> Result<Option<i32>, ClientError>

Closes stdin (orderly server shutdown) and waits for the child to exit.

Errors

Waiting for the child failed.

pub async fn prompt( &self, message: impl Into<String>, images: Vec<ImageContent>, streaming_behavior: Option<StreamingBehavior>, ) -> Result<PromptDisposition, ClientError>

prompt.

Errors

Prompt errors.

pub async fn steer( &self, message: impl Into<String>, images: Vec<ImageContent>, ) -> Result<PromptDisposition, ClientError>

steer.

Errors

Extension commands cannot be queued.

pub async fn follow_up( &self, message: impl Into<String>, images: Vec<ImageContent>, ) -> Result<PromptDisposition, ClientError>

follow_up.

Errors

Extension commands cannot be queued.

pub async fn abort(&self) -> Result<(), ClientError>

abort.

Errors

Transport failures.

pub async fn clear_queue(&self) -> Result<ClearedQueues, ClientError>

clear_queue.

Errors

Transport failures.

pub async fn new_session( &self, parent_session: Option<String>, ) -> Result<bool, ClientError>

new_session; true when an extension cancelled.

Errors

Session file failures.

pub async fn get_state(&self) -> Result<RpcSessionState, ClientError>

get_state.

Errors

Transport failures.

pub async fn set_model( &self, provider: impl Into<String>, model_id: impl Into<String>, ) -> Result<Model, ClientError>

set_model.

Errors

Model not found: …, missing credentials.

pub async fn cycle_model(&self) -> Result<Option<CycleModelResult>, ClientError>

cycle_model.

Errors

Persisting the selection failed.

pub async fn get_available_models(&self) -> Result<Vec<Model>, ClientError>

get_available_models.

Errors

Transport failures.

pub async fn set_thinking_level( &self, level: ThinkingLevel, ) -> Result<(), ClientError>

set_thinking_level.

Errors

Transport failures.

pub async fn cycle_thinking_level( &self, ) -> Result<Option<ThinkingLevel>, ClientError>

cycle_thinking_level.

Errors

Transport failures.

pub async fn get_available_thinking_levels( &self, ) -> Result<Vec<ThinkingLevel>, ClientError>

get_available_thinking_levels.

Errors

Transport failures.

pub async fn set_steering_mode( &self, mode: QueueMode, ) -> Result<(), ClientError>

set_steering_mode.

Errors

Transport failures.

pub async fn set_follow_up_mode( &self, mode: QueueMode, ) -> Result<(), ClientError>

set_follow_up_mode.

Errors

Transport failures.

pub async fn compact( &self, custom_instructions: Option<String>, ) -> Result<CompactionResult, ClientError>

compact.

Errors

Compaction errors.

pub async fn set_auto_compaction( &self, enabled: bool, ) -> Result<(), ClientError>

set_auto_compaction.

Errors

Transport failures.

pub async fn set_auto_retry(&self, enabled: bool) -> Result<(), ClientError>

set_auto_retry.

Errors

Transport failures.

pub async fn abort_retry(&self) -> Result<(), ClientError>

abort_retry.

Errors

Transport failures.

pub async fn bash( &self, command: impl Into<String>, exclude_from_context: bool, ) -> Result<BashResult, ClientError>

bash.

Errors

The command could not run.

pub async fn abort_bash(&self) -> Result<(), ClientError>

abort_bash.

Errors

Transport failures.

pub async fn get_session_stats(&self) -> Result<SessionStats, ClientError>

get_session_stats.

Errors

Transport failures.

pub async fn export_html( &self, output_path: Option<String>, ) -> Result<String, ClientError>

export_html; returns the written path.

Errors

Write failures.

pub async fn switch_session( &self, session_path: impl Into<String>, ) -> Result<bool, ClientError>

switch_session; true when an extension cancelled.

Errors

The file cannot be opened.

pub async fn fork( &self, entry_id: impl Into<String>, ) -> Result<ForkOutcome, ClientError>

fork.

Errors

Invalid entry ID for forking.

pub async fn clone_session(&self) -> Result<bool, ClientError>

clone; true when an extension cancelled.

Errors

Cannot clone session: no current entry selected.

pub async fn get_fork_messages(&self) -> Result<Vec<ForkMessage>, ClientError>

get_fork_messages.

Errors

Transport failures.

pub async fn get_entries( &self, since: Option<String>, ) -> Result<EntriesOutcome, ClientError>

get_entries.

Errors

Entry not found: ….

pub async fn get_tree(&self) -> Result<EntriesOutcome, ClientError>

get_tree (nodes as JSON in EntriesOutcome::entries).

Errors

Transport failures.

pub async fn get_last_assistant_text( &self, ) -> Result<Option<String>, ClientError>

get_last_assistant_text.

Errors

Transport failures.

pub async fn set_session_name( &self, name: impl Into<String>, ) -> Result<(), ClientError>

set_session_name.

Errors

Session name cannot be empty.

pub async fn get_messages(&self) -> Result<Vec<AgentMessage>, ClientError>

get_messages.

Errors

Transport failures.

pub async fn get_commands(&self) -> Result<Vec<SlashCommandInfo>, ClientError>

get_commands.

Errors

Transport failures.

Trait Implementations

impl Clone for RpcClient

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RpcClient

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

Formats the value using the given formatter.