Struct Auth 

pub struct Auth {
    pub api_key: Option<String>,
    pub headers: IndexMap<String, Option<String>>,
    pub source: Option<String>,
    pub base_url: Option<String>,
    pub error: Option<String>,
    pub env: Option<ProviderEnv>,
}

Credentials for one request.

Fields

api_key: Option<String>

The API key, if the provider takes one.

headers: IndexMap<String, Option<String>>

Headers that carry or accompany the credential. None removes a header.

source: Option<String>

Where the credential came from, for messages.

base_url: Option<String>

Replaces the model’s base URL, for accounts with their own endpoint.

error: Option<String>

Why credentials could not be resolved. A request with it fails.

env: Option<ProviderEnv>

Provider settings from the credential, such as a Cloudflare account id, that the request reads ahead of the process environment.

Implementations

impl Auth

pub fn apply(self, request: &mut Request) -> Result<(), String>

Applies the credentials to a request: the key when there is one, headers over the request’s, and the account’s base URL. Fails with Auth::error when credentials could not be resolved.

Trait Implementations

impl Clone for Auth

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 Auth

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

Formats the value using the given formatter.

impl Default for Auth

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Auth

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Auth