Skip to main content

MetadataCache

Struct MetadataCache 

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

AS metadata cache.

Implementations§

Source§

impl MetadataCache

Source

pub fn new( fetcher: DocumentFetcherFn, expected_issuer: impl Into<String>, fetch_settings: FetchSettings, refresh_seconds: u64, on_change: Option<MetadataChangeCallback>, ) -> Self

Create a new metadata cache.

fetcher MUST GET the AS metadata document. expected_issuer is the issuer the application configured; the discovered document is rejected if its issuer field does not match exactly (RFC 8414).

Source

pub fn document_cache(&self) -> Arc<DocumentCache> ⓘ

Underlying DocumentCache (for aclose() plumbing).

Source

pub async fn aclose(&self)

Cancel any background refresh task.

Source

pub async fn get_metadata(&self) -> Result<Value, AuthplaneError>

Return the cached metadata document, refreshing if expired.

Source

pub async fn refresh(&self) -> Result<Value, AuthplaneError>

Force-refresh and return the metadata document.

Source

pub async fn endpoint(&self, key: &str) -> Result<String, AuthplaneError>

Read a specific endpoint URL out of the cached metadata.

Source

pub async fn get_jwks_uri(&self) -> Result<String, AuthplaneError>

Convenience accessor for jwks_uri. The URL is validated through the fetch settings (HTTPS-only, SSRF, …).

Source

pub async fn get_token_endpoint(&self) -> Result<String, AuthplaneError>

Convenience accessor for token_endpoint.

Source

pub async fn get_introspection_endpoint(&self) -> Result<String, AuthplaneError>

Convenience accessor for introspection_endpoint.

Source

pub async fn get_revocation_endpoint(&self) -> Result<String, AuthplaneError>

Convenience accessor for revocation_endpoint.

Trait Implementations§

Source§

impl Clone for MetadataCache

Source§

fn clone(&self) -> Self

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 MetadataCache

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