Skip to main content

OAuthCredential

Struct OAuthCredential 

Source
#[non_exhaustive]
pub struct OAuthCredential { pub access_token: String, pub refresh_token: Option<String>, pub expires_at_ms: i64, pub subscription_type: Option<String>, pub scopes: Vec<String>, }
Expand description

A refreshable OAuth credential read from / written to the claude CLI’s credential file.

Field naming mirrors the on-disk JSON exactly so deserialization stays a one-line serde_json::from_slice. #[non_exhaustive] closes off direct struct-literal construction so future server-returned fields ship as additive minor releases — use OAuthCredential::new plus the with_* chain.

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.
§access_token: String

Bearer token forwarded to Anthropic in the Authorization header.

§refresh_token: Option<String>

Long-lived refresh token. None means the credential cannot renew itself once the access token expires.

§expires_at_ms: i64

Unix-millis epoch at which the access token expires.

§subscription_type: Option<String>

pro / team / etc. — informational, not load-bearing for transport. Preserved across refresh so storage round-trips keep the original metadata.

§scopes: Vec<String>

OAuth scopes granted to this token. Preserved across refresh.

Implementations§

Source§

impl OAuthCredential

Source

pub fn new(access_token: impl Into<String>, expires_at_ms: i64) -> Self

Construct a credential from the two mandatory fields. Use the with_* chain for the optional ones.

Source

pub fn with_refresh_token(self, token: impl Into<String>) -> Self

Set the long-lived refresh token.

Source

pub fn with_subscription_type(self, tier: impl Into<String>) -> Self

Set the subscription tier (pro / team / …).

Source

pub fn with_scopes<I, S>(self, scopes: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Replace the granted-scopes list.

Source

pub fn expires_at(&self) -> Option<DateTime<Utc>>

Wall-clock instant the access token expires, or None when expires_at_ms does not represent a valid Unix-millis epoch (storage corruption / server bug). Surfaces the loss explicitly rather than coercing to “now” — the credential is then treated as already expired by Self::needs_refresh.

Source

pub fn needs_refresh(&self) -> bool

True when the access token is past its expiry — resolve must trigger a refresh before handing the token to a transport. An unrepresentable expires_at_ms (storage corruption, server bug) reads as already-expired so the provider refreshes rather than handing out a stale token. Includes a 60-second skew window so a token about to expire mid-flight refreshes proactively.

Source

pub fn to_bearer_secret(&self) -> SecretString

Wrap the access token in a SecretString formatted as Bearer <token> for transport use. Allocates a fresh secret per call so callers can hand it straight to entelix_core::auth::Credentials::header_value.

Trait Implementations§

Source§

impl Clone for OAuthCredential

Source§

fn clone(&self) -> OAuthCredential

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 OAuthCredential

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for OAuthCredential

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for OAuthCredential

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> 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: 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: 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> 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<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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,