Struct CredentialSlot 

#[non_exhaustive]
pub struct CredentialSlot {
    pub scope: Cow<'static, str>,
    pub placement: CredentialPlacement,
    pub replaces: Vec<Cow<'static, str>>,
    pub required: bool,
}

Where an adapter takes its per-request credential from, and where it puts it: the adapter’s side of a Credential.

Every HTTP adapter declares one and passes it to HttpRequest::apply_options, which then:

• places the Credential::api_key addressed to scope as placement says, removing the configured credential and every header in replaces;
• adds the Credential::header values addressed to the scope;
• ignores credentials addressed to any other scope;
• refuses plain headers that would set a credential (see HttpRequest::apply_options).

The scope names an account, not a wire format: it is independent of the provider name and the namespaces, so telemetry identity never changes with it. Bundled adapters default it to their provider name and publish that default as DEFAULT_CREDENTIAL_SCOPE; their builders change it with credential_scope. Two accounts of one provider in a fallback chain need two scopes, and providers behind one gateway share one.

use allama_http::{CredentialPlacement, CredentialSlot};

// An API that takes its key in `x-nimbus-key`, and also accepts an
// `Authorization` header that a tenant key must replace.
let slot = CredentialSlot::new("nimbus", CredentialPlacement::Header("x-nimbus-key".into()))
    .replaces("authorization");
assert_eq!(slot.header_name(), Some("x-nimbus-key"));

Fields (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.

scope: Cow<'static, str>

The credential scope: credentials addressed to it are this adapter’s.

placement: CredentialPlacement

Where the scope’s Credential::api_key goes.

replaces: Vec<Cow<'static, str>>

Configured authentication headers the credential replaces, besides the placement’s own header: for example Entra ID’s authorization on an endpoint whose keys go in api-key. Plain headers with these names are refused, like the placement’s own header.

required: bool

Whether every request must carry a credential for the scope: set when the adapter has no configured credential (bring your own key). A request without one fails with an authored allama::Error::Configuration before anything is sent.

Implementations

impl CredentialSlot

pub fn new( scope: impl Into<Cow<'static, str>>, placement: CredentialPlacement, ) -> Self

A slot for scope, placed as placement, replacing nothing else and not required.

pub fn replaces(self, name: impl Into<Cow<'static, str>>) -> Self

Also replace the configured header name (see replaces).

pub fn required(self, required: bool) -> Self

Require a credential for the scope on every request (see required).

pub fn header_name(&self) -> Option<&str>

The header the placement writes: authorization for Bearer, the name for Header, and None for Custom.

Trait Implementations

impl Clone for CredentialSlot

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 CredentialSlot

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

Formats the value using the given formatter.

impl Eq for CredentialSlot

impl PartialEq for CredentialSlot

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CredentialSlot