Struct HeaderAuthRules 

pub struct HeaderAuthRules {
    pub required_headers: Vec<RequiredHeader>,
    pub auth_required: Option<String>,
    pub api_key_required: bool,
    pub authorization_header_required: Option<String>,
    pub api_key_header: Option<String>,
}

The route-level header and authentication rules.

The reference RouteConfig fields required_headers, auth_required, api_key_required, authorization_header_required, and api_key_header. The default has no rules: the gate passes.

Fields

required_headers: Vec<RequiredHeader>

required_headers: checked in order, before authentication.

auth_required: Option<String>

auth_required: the authentication scheme ("bearer", "basic", or any other scheme name).

api_key_required: bool

api_key_required: demand a non-empty api_key_header value.

authorization_header_required: Option<String>

authorization_header_required: a presence-only scheme check that short-circuits the other two authentication paths.

api_key_header: Option<String>

api_key_header: the header the API key is read from.

Implementations

impl HeaderAuthRules

pub const fn has_rules(&self) -> bool

Whether any rule is configured (the reference applies_to predicates).

Trait Implementations

impl Clone for HeaderAuthRules

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 HeaderAuthRules

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

Formats the value using the given formatter.

impl Default for HeaderAuthRules

fn default() -> Self

Returns the “default value” for a type.

impl Eq for HeaderAuthRules

impl PartialEq for HeaderAuthRules

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HeaderAuthRules