Enum Auth 

pub enum Auth {
    None,
    Bearer(String),
    Basic {
        username: String,
        password: String,
    },
    ApiKey {
        header: String,
        value: String,
    },
    ApiKeyQuery {
        param: String,
        value: String,
    },
    OAuth2 {
        token_url: String,
        client_id: String,
        client_secret: String,
        scopes: Vec<String>,
        expiry_ratio: f64,
    },
    Custom(HeaderMap),
}

Supported authentication methods.

Variants

None

Bearer(String)

Basic

Fields

username: String

password: String

ApiKey

API key sent in a request header.

Fields

header: String

value: String

ApiKeyQuery

API key sent as a query parameter (e.g. ?api_key=secret).

Some APIs require the key in the URL rather than a header. The param field is the query parameter name, and value is the key itself.

Fields

param: String

value: String

OAuth2

Fields

token_url: String

client_id: String

client_secret: String

scopes: Vec<String>

expiry_ratio: f64

Fraction of expires_in after which the cached token is considered expired and a new one is fetched. Must be in (0.0, 1.0]. Defaults to 0.9 (refresh after 90 % of the token lifetime).

Custom(HeaderMap)

Implementations

impl Auth

pub fn apply(&self, headers: &mut HeaderMap) -> Result<(), FaucetError>

Apply header-based auth to the request headers.

ApiKeyQuery is a no-op here — it is applied as a query parameter by RestStream::execute_request instead.

Trait Implementations

impl Clone for Auth

fn clone(&self) -> Auth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Auth

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

Formats the value using the given formatter.