Skip to main content

CredentialRequest

Struct CredentialRequest 

Source
#[non_exhaustive]
pub struct CredentialRequest<'req> { pub env: &'req str, pub command: &'req str, pub tier: &'req str, pub meta: &'req CommandMeta, }
Expand description

Everything an AuthProvider may inspect about the command requesting a credential.

This bundles the routing fields passed to AuthProvider::get_credential (env, colon command path, and tier) together with the command’s CommandMeta, so a provider can read richer metadata — for example an OAuth provider reading CommandMeta::scopes to decide whether the cached token is sufficient. Providers that do not need metadata can ignore it.

Marked #[non_exhaustive] because the framework constructs it (providers only read it) and more request fields may be added over time; build one with CredentialRequest::new rather than a struct literal so adding a field is not a breaking change for downstream crates.

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.
§env: &'req str

Target environment name.

§command: &'req str

Colon-separated command path, for example project:list.

§tier: &'req str

Risk tier as a string, for example read or mutate.

§meta: &'req CommandMeta

Metadata for the command requesting the credential.

Implementations§

Source§

impl<'req> CredentialRequest<'req>

Source

pub fn new( env: &'req str, command: &'req str, tier: &'req str, meta: &'req CommandMeta, ) -> Self

Creates a request from the routing fields and command metadata.

Trait Implementations§

Source§

impl<'req> Clone for CredentialRequest<'req>

Source§

fn clone(&self) -> CredentialRequest<'req>

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<'req> Copy for CredentialRequest<'req>

Source§

impl<'req> Debug for CredentialRequest<'req>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'req> Freeze for CredentialRequest<'req>

§

impl<'req> RefUnwindSafe for CredentialRequest<'req>

§

impl<'req> Send for CredentialRequest<'req>

§

impl<'req> Sync for CredentialRequest<'req>

§

impl<'req> Unpin for CredentialRequest<'req>

§

impl<'req> UnsafeUnpin for CredentialRequest<'req>

§

impl<'req> UnwindSafe for CredentialRequest<'req>

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