Enum Authentication 

#[non_exhaustive]
pub enum Authentication {
    None,
    Scan {
        api_key: Option<Secret>,
        api_token: Option<Secret>,
    },
    OAuth {
        provider: Arc<dyn TokenProvider>,
        tsg_header: Option<String>,
    },
    RuntimeKey {
        api_key: Secret,
    },
}

Per-client authentication. Credentials never enter ordinary formatting.

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.

None

Scan

Fields

api_key: Option<Secret>

api_token: Option<Secret>

OAuth

Fields

provider: Arc<dyn TokenProvider>

tsg_header: Option<String>

RuntimeKey

Fields

api_key: Secret

Implementations

impl Authentication

pub fn scan(api_key: Option<Secret>, api_token: Option<Secret>) -> Result<Self>

pub fn oauth(provider: Arc<dyn TokenProvider>, with_tsg_header: bool) -> Self

Bind the optional tenant header to the provider’s immutable context.

pub fn runtime_key(api_key: Secret) -> Result<Self>

pub async fn prepare( &self, headers: &mut HeaderMap, body: &Bytes, has_body: bool, options: &RequestOptions, ) -> Result<Option<u64>>

Attach protected headers after destination admission. Returns the OAuth token generation used so a later 401 can invalidate precisely that lease.

pub fn on_unauthorized(&self, generation: u64) -> bool

Trait Implementations

impl Clone for Authentication

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 Authentication

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

Formats the value using the given formatter.