Skip to main content

ClientSessionData

Struct ClientSessionData 

Source
pub struct ClientSessionData<S: BosStr = DefaultStr> {
    pub account_did: Did<S>,
    pub session_id: S,
    pub host_url: Uri<String>,
    pub authserver_url: S,
    pub authserver_token_endpoint: S,
    pub authserver_revocation_endpoint: Option<S>,
    pub scopes: Scopes<S>,
    pub dpop_data: DpopClientData,
    pub token_set: TokenSet<S>,
    pub resolved_scopes: Option<Vec<Scope<SmolStr>>>,
}
Expand description

Persisted information about an OAuth session. Used to resume an active session.

Fields§

§account_did: Did<S>

DID of the authenticated account; serves as the primary key for session storage because only one active session per account is assumed.

§session_id: S

Opaque identifier that distinguishes this session from other sessions for the same account.

Reuses the random state token generated during the PAR flow.

§host_url: Uri<String>

Base URL of the resource server (PDS): scheme, host, and port only

§authserver_url: S

Base URL of the authorization server (PDS or entryway): scheme, host, and port only

§authserver_token_endpoint: S

Full URL of the authorization server’s token endpoint.

§authserver_revocation_endpoint: Option<S>

Full URL of the authorization server’s revocation endpoint, if advertised.

§scopes: Scopes<S>

The set of OAuth scopes approved for this session, as returned in the initial token response.

§dpop_data: DpopClientData

DPoP key and nonce state for ongoing requests in this session.

§token_set: TokenSet<S>

Current token set (access token, refresh token, expiry, etc.).

§resolved_scopes: Option<Vec<Scope<SmolStr>>>

Fully expanded scopes with include scopes resolved.

This is populated eagerly at session creation when scope-check is enabled. It is None when scope checking is not enabled, when no eager resolution was performed, or when reading older persisted sessions that predate this field.

Implementations§

Source§

impl<S: BosStr + Ord + AsRef<str>> ClientSessionData<S>

Source

pub fn update_with_tokens(&mut self, token_set: &TokenSet<S>)
where S: FromStr + Clone + From<SmolStr> + AsRef<str>, S::Err: Debug,

Update this session’s token set and, if the new token set includes scopes, replace the scope list.

Called after a successful token refresh so that any scope changes returned by the server are reflected in the persisted session without requiring a full re-authentication.

This method is only available on DefaultStr-backed sessions (the common case for in-memory sessions). Zero-copy borrowed sessions are read-only by nature and would not be refreshed in place.

Trait Implementations§

Source§

impl<S: Clone + BosStr> Clone for ClientSessionData<S>

Source§

fn clone(&self) -> ClientSessionData<S>

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<S: Debug + BosStr> Debug for ClientSessionData<S>

Source§

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

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

impl<'de, S> Deserialize<'de> for ClientSessionData<S>
where S: Deserialize<'de> + BosStr + AsRef<str>,

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<S: Eq + BosStr> Eq for ClientSessionData<S>

Source§

impl<S: BosStr + Ord + IntoStatic + AsRef<str>> IntoStatic for ClientSessionData<S>
where S::Output: BosStr + Ord + AsRef<str>,

Source§

type Output = ClientSessionData<<S as IntoStatic>::Output>

The “owned” variant of the type. For Cow<'a, str>, this is Cow<'static, str>, for example.
Source§

fn into_static(self) -> Self::Output

Turns the value into an “owned” variant, which can then be returned, moved, etc. Read more
Source§

impl<S: PartialEq + BosStr> PartialEq for ClientSessionData<S>

Source§

fn eq(&self, other: &ClientSessionData<S>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<S> Serialize for ClientSessionData<S>
where S: Serialize + BosStr + Ord,

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

impl<T: ClientAuthStore + Send + Sync> SessionStore<SessionKey, ClientSessionData> for Arc<T>

Source§

async fn get(&self, key: &SessionKey) -> Option<ClientSessionData>

Get the current session if present.

Source§

async fn set( &self, _key: SessionKey, session: ClientSessionData, ) -> Result<(), SessionStoreError>

Persist the given session.

Source§

async fn del(&self, key: &SessionKey) -> Result<(), SessionStoreError>

Delete the given session.

Source§

async fn list_keys(&self) -> Result<Vec<SessionKey>, SessionStoreError>

List known session keys when the backend supports enumeration.
Source§

impl<S: PartialEq + BosStr> StructuralPartialEq for ClientSessionData<S>

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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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