Enum CredentialPlacement 

#[non_exhaustive]
pub enum CredentialPlacement {
    Header {
        name: String,
        value: String,
    },
    Query {
        name: String,
        value: String,
    },
    Cookie {
        name: String,
        value: String,
    },
    BodyField {
        name: String,
        value: String,
    },
}

One placement of a captured credential into an outgoing HTTP request, produced by AuthProvider::request_auth. Unlike Credential (which is header/bearer-shaped), a placement can target a query parameter, cookie, or JSON body field — the shapes multi-step auth flows (#511) need.

#[non_exhaustive] so new placement kinds can be added as a minor change.

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.

Header

An HTTP header name: value.

Fields

name: String

Header name.

value: String

Header value.

Query

A query-string parameter ?name=value.

Fields

name: String

Parameter name.

value: String

Parameter value.

Cookie

A cookie name=value (sent via the Cookie header).

Fields

name: String

Cookie name.

value: String

Cookie value.

BodyField

A top-level field of the JSON request body.

Fields

name: String

Field name.

value: String

Field value (string).

Trait Implementations

impl Clone for CredentialPlacement

fn clone(&self) -> CredentialPlacement

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: &CredentialPlacement) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CredentialPlacement