Skip to main content

ClientRpcAccount

Struct ClientRpcAccount 

Source
pub struct ClientRpcAccount<'a> { /* private fields */ }
Expand description

account.* RPCs.

Implementations§

Source§

impl<'a> ClientRpcAccount<'a>

Source

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

Gets Copilot quota usage for the authenticated user or supplied GitHub token.

Wire method: account.getQuota.

§Returns

Quota usage snapshots for the resolved user, keyed by quota type.

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.

Source

pub async fn get_quota_with_params( &self, params: AccountGetQuotaRequest, ) -> Result<AccountGetQuotaResult, Error>

Gets Copilot quota usage for the authenticated user or supplied GitHub token.

Wire method: account.getQuota.

§Parameters
  • params - Optional GitHub token used to look up quota for a specific user instead of the global auth context.
§Returns

Quota usage snapshots for the resolved user, keyed by quota type.

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.

Source

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

Gets the currently active authentication credentials from the global auth manager.

Wire method: account.getCurrentAuth.

§Returns

Current authentication state

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.

Source

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

Gets all authenticated users available for account switching.

Wire method: account.getAllUsers.

§Returns

List of all authenticated users

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.

Source

pub async fn login( &self, params: AccountLoginRequest, ) -> Result<AccountLoginResult, Error>

Stores authentication credentials after successful login (e.g., device code flow).

Wire method: account.login.

§Parameters
  • params - Credentials to store after successful authentication
§Returns

Result of a successful login; throws on failure

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.

Source

pub async fn logout( &self, params: AccountLogoutRequest, ) -> Result<AccountLogoutResult, Error>

Removes user authentication from keychain and persisted state.

Wire method: account.logout.

§Parameters
  • params - User to log out
§Returns

Logout result indicating if more users remain

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§

Source§

impl<'a> Clone for ClientRpcAccount<'a>

Source§

fn clone(&self) -> ClientRpcAccount<'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
Source§

impl<'a> Copy for ClientRpcAccount<'a>

Auto Trait Implementations§

§

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

§

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

§

impl<'a> Freeze for ClientRpcAccount<'a>

§

impl<'a> Send for ClientRpcAccount<'a>

§

impl<'a> Sync for ClientRpcAccount<'a>

§

impl<'a> Unpin for ClientRpcAccount<'a>

§

impl<'a> UnsafeUnpin for ClientRpcAccount<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

Source§

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
Source§

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

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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