Skip to main content

AuthStatus

Struct AuthStatus 

Source
#[non_exhaustive]
pub struct AuthStatus { pub agent: Agent, pub state: AuthState, pub method: Option<String>, pub account: Option<String>, pub plan: Option<String>, pub detail: String, pub login_hint: &'static str, }
Expand description

What an agent reported about its credentials.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§agent: Agent

The agent asked.

§state: AuthState

What it said.

§method: Option<String>

How it is authenticated, in its own words: claude.ai, ChatGPT, an API key. None when it did not say.

§account: Option<String>

The account, where the agent reports one. Claude gives an email.

§plan: Option<String>

The plan or subscription, where reported.

§detail: String

The CLI’s own output, or an explanation when it could not be asked.

§login_hint: &'static str

The command that resolves a missing login.

Implementations§

Source§

impl AuthStatus

Source

pub async fn check(agent: Agent) -> Result<AuthStatus>

Ask agent’s default binary.

§Errors

Error::NotInstalled if the binary is missing, Error::Spawn if it cannot be run. A CLI that answers “logged out” is a successful check, not an error.

Source

pub async fn check_bin(agent: Agent, bin: &str) -> Result<AuthStatus>

Ask a specific binary, for a caller overriding the path with crate::Request::bin.

§Errors

Error::NotInstalled if the binary is missing, Error::Spawn if it cannot be run.

Source

pub fn is_logged_in(&self) -> bool

Whether the agent confirmed it is logged in.

False for AuthState::Unknown, so a caller that gates on this is conservative. Check state directly to distinguish “no” from “cannot tell”.

Source

pub fn needs_login(&self) -> bool

Whether the answer means someone has to log in.

Only a confirmed logout. An agent that cannot be asked is not evidence of a problem.

Source

pub fn summary(&self) -> String

One line fit to show in a settings screen.

Trait Implementations§

Source§

impl Clone for AuthStatus

Source§

fn clone(&self) -> AuthStatus

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 Debug for AuthStatus

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.