Enum CredentialPlacement 

#[non_exhaustive]
pub enum CredentialPlacement {
    Bearer,
    Header(Cow<'static, str>),
    Custom,
}

Where an adapter puts its scope’s Credential::api_key.

There is no query-string placement: with http-tracing, the request URL, query included, is recorded on spans. An adapter whose API takes its key in the query uses Custom and owns the redaction.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Bearer

Authorization: Bearer <secret>.

Header(Cow<'static, str>)

<name>: <secret>, such as x-api-key.

Custom

The adapter places the credential itself, for example to sign the request. HttpRequest::apply_options leaves the scope’s Credential::api_key alone; the adapter reads it with HttpRequestOptions::credential_for and applies it after apply_options, which adds the plain headers a signature covers. It refuses a kind it cannot place with Credential::unsupported.

Trait Implementations

impl Clone for CredentialPlacement

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CredentialPlacement

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

Formats the value using the given formatter.

impl Eq for CredentialPlacement

impl PartialEq for CredentialPlacement

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CredentialPlacement