Skip to main content

Dispatcher

Struct Dispatcher 

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

Routes auth operations to registered providers by name.

Clones share the same provider registry, so provider facades and transport injectors see later registration or replacement.

Implementations§

Source§

impl Dispatcher

Source

pub fn new() -> Self

Creates an empty dispatcher.

Source

pub fn register(&mut self, provider: Arc<dyn AuthProvider>)

Registers or replaces a provider under its AuthProvider::name.

Source

pub fn registered_names(&self) -> Vec<String>

Returns provider names in registration order.

Source

pub async fn get_credential( &self, name: &str, env: &str, command: &str, tier: &str, ) -> Result<Credential>

Gets a credential from a named provider.

Source

pub async fn get_credential_for( &self, name: &str, req: &CredentialRequest<'_>, ) -> Result<Credential>

Gets a credential from a named provider, passing the command’s full CredentialRequest so metadata-aware providers (e.g. OAuth scope step-up) can act on it.

Source

pub async fn login(&self, name: &str, env: &str) -> Result<Credential>

Clears any cached credential, ignoring logout failures, then authenticates.

Source

pub async fn login_with_scopes( &self, name: &str, env: &str, additional_scopes: &[String], ) -> Result<Credential>

Like login, but requests additional_scopes on top of the provider’s defaults.

The scopes are carried as CommandMeta::scopes on a synthesized request; providers without scope support ignore them.

Source

pub async fn status(&self, name: &str, env: &str) -> Result<Credential>

Gets cached credential status from a named provider.

Source

pub async fn logout(&self, name: &str, env: &str) -> Result<()>

Clears cached credentials for a named provider and environment.

Source

pub async fn all_statuses(&self) -> Vec<StatusEntry>

Queries every provider for every cached environment it reports.

Source

pub fn for_provider(&self, name: impl Into<String>) -> SingleProvider

Returns an auth-provider facade backed by this dispatcher.

Trait Implementations§

Source§

impl Clone for Dispatcher

Source§

fn clone(&self) -> Dispatcher

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 Dispatcher

Source§

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

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

impl Default for Dispatcher

Source§

fn default() -> Dispatcher

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