Skip to main content

SessionRpcAgent

github_copilot_sdk::generated::rpc

Struct SessionRpcAgent

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

Expand description

session.agent.* RPCs.

Implementations§

impl<'a> SessionRpcAgent<'a>

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

Lists custom agents available to the session.

Wire method: session.agent.list.

§Returns

Custom agents available to 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 get_current(&self) -> Result<AgentGetCurrentResult, Error>

Gets the currently selected custom agent for the session.

Wire method: session.agent.getCurrent.

§Returns

The currently selected custom agent, or null when using the default agent.

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 select( &self, params: AgentSelectRequest, ) -> Result<AgentSelectResult, Error>

Selects a custom agent for subsequent turns in the session.

Wire method: session.agent.select.

§Parameters

params - Name of the custom agent to select for subsequent turns.

§Returns

The newly selected custom agent.

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 deselect(&self) -> Result<(), Error>

Clears the selected custom agent and returns the session to the default agent.

Wire method: session.agent.deselect.

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 reload(&self) -> Result<AgentReloadResult, Error>

Reloads custom agent definitions and returns the refreshed list.

Wire method: session.agent.reload.

§Returns

Custom agents available to the session after reloading definitions from disk.

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 SessionRpcAgent<'a>

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

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<'a> Copy for SessionRpcAgent<'a>

Auto Trait Implementations§

impl<'a> Freeze for SessionRpcAgent<'a>

impl<'a> !RefUnwindSafe for SessionRpcAgent<'a>

impl<'a> Send for SessionRpcAgent<'a>

impl<'a> Sync for SessionRpcAgent<'a>

impl<'a> Unpin for SessionRpcAgent<'a>

impl<'a> UnsafeUnpin for SessionRpcAgent<'a>

impl<'a> !UnwindSafe for SessionRpcAgent<'a>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more