Skip to main content

SessionRpcQueue

github_copilot_sdk::generated::rpc

Struct SessionRpcQueue

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

Expand description

session.queue.* RPCs.

Implementations§

impl<'a> SessionRpcQueue<'a>

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

Returns the local session’s pending user-facing queued items and steering messages.

Wire method: session.queue.pendingItems.

§Returns

Snapshot of the session’s pending queued items and immediate-steering messages.

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

Removes the most recently queued user-facing item (LIFO).

Wire method: session.queue.removeMostRecent.

§Returns

Indicates whether a user-facing pending item was removed.

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

Clears all pending queued items on the local session.

Wire method: session.queue.clear.

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

fn clone(&self) -> SessionRpcQueue<'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 SessionRpcQueue<'a>

Auto Trait Implementations§

impl<'a> Freeze for SessionRpcQueue<'a>

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

impl<'a> Send for SessionRpcQueue<'a>

impl<'a> Sync for SessionRpcQueue<'a>

impl<'a> Unpin for SessionRpcQueue<'a>

impl<'a> UnsafeUnpin for SessionRpcQueue<'a>

impl<'a> !UnwindSafe for SessionRpcQueue<'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