Skip to main content

AuthCache

Struct AuthCache 

Source
pub struct AuthCache { /* private fields */ }
Expand description

In-memory view of ~/.config/dsp-cli/auth.toml.

Load with AuthCache::load (or AuthCache::load_from in tests). Mutate with AuthCache::set_token and AuthCache::remove. Persist with AuthCache::save (or AuthCache::save_to in tests).

Internal layout is a BTreeMap (not HashMap) so the on-disk TOML has deterministic key order. The toml crate serialises a BTreeMap<String, T> at the root as a sequence of standalone [key] tables, which is the shape ADR-0007 specifies — no wrapper struct or #[serde(flatten)] needed.

Implementations§

Source§

impl AuthCache

Source

pub fn default_path() -> Result<PathBuf, Diagnostic>

The canonical cache path: ~/.config/dsp-cli/auth.toml.

Returns an error if the home directory cannot be resolved.

Source

pub fn load() -> Result<Self, Diagnostic>

Load the cache from Self::default_path.

A missing file is not an error — it means no tokens are cached yet.

Source

pub fn load_from(path: &Path) -> Result<Self, Diagnostic>

Load the cache from an explicit path.

A missing file is not an error — returns an empty cache. Files whose reported size exceeds MAX_CACHE_FILE_BYTES are rejected before the contents are read, so a symlink pointing at a huge file fails fast.

Source

pub fn save(&self) -> Result<(), Diagnostic>

Save the cache to Self::default_path.

Creates the parent directory if it does not exist. On Unix, the file is created with mode 0600.

Source

pub fn save_to(&self, path: &Path) -> Result<(), Diagnostic>

Save the cache to an explicit path.

Creates the parent directory if it does not exist. On Unix, the file is created with mode 0600.

Source

pub fn token(&self, server: &str) -> Option<&str>

Return the cached token for server, if any.

Source

pub fn user(&self, server: &str) -> Option<&str>

Return the cached user for server, if any.

Source

pub fn acquired_at(&self, server: &str) -> Option<DateTime<Utc>>

Return the acquired_at timestamp for server, if any.

Source

pub fn expires_at(&self, server: &str) -> Option<DateTime<Utc>>

Return the expires_at timestamp for server, if any.

Source

pub fn set_entry(&mut self, server: impl Into<String>, entry: ServerEntry)

Insert or replace a fully-populated entry for server.

Prefer this over set_token when the full entry shape is available (e.g. after a login that returns user + expiry). set_token remains as a thin convenience for callers that only have a token.

Source

pub fn set_token(&mut self, server: String, token: String)

Insert or replace the token for server.

Convenience wrapper that constructs a partial ServerEntry with only the token set, leaving user, acquired_at, and expires_at as None. Use set_entry when the full shape is available.

Source

pub fn remove(&mut self, server: &str) -> bool

Remove the token for server.

Returns true if an entry was present and removed, false otherwise.

Source

pub fn is_empty(&self) -> bool

Return true if no tokens are cached.

Trait Implementations§

Source§

impl Debug for AuthCache

Source§

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

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

impl Default for AuthCache

Source§

fn default() -> AuthCache

Returns the “default value” for a type. 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> 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> Same for T

Source§

type Output = T

Should always be Self
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