Struct ApiKeyConfig 

pub struct ApiKeyConfig { /* private fields */ }

Configuration for API Key authentication.

Implementations

impl ApiKeyConfig

pub fn new() -> Self

Creates a new configuration with default settings.

pub fn header(name: impl Into<String>) -> Self

Creates a configuration that looks for the API key in a header.

pub fn query(name: impl Into<String>) -> Self

Creates a configuration that looks for the API key in a query parameter.

pub fn authorization(scheme: impl Into<String>) -> Self

Creates a configuration that looks for the API key in the Authorization header.

pub fn add_location(self, location: ApiKeyLocation) -> Self

Adds a location to look for the API key.

pub fn locations(self, locations: Vec<ApiKeyLocation>) -> Self

Sets the locations to look for the API key.

pub fn validate_expiration(self, validate: bool) -> Self

Sets whether to validate key expiration.

pub fn validate_enabled(self, validate: bool) -> Self

Sets whether to check if the key is enabled.

pub fn realm(self, realm: impl Into<String>) -> Self

Sets the realm for authentication challenges.

pub fn get_locations(&self) -> &[ApiKeyLocation]

Returns the locations to check for the API key.

pub fn should_validate_expiration(&self) -> bool

Returns whether to validate key expiration.

pub fn should_validate_enabled(&self) -> bool

Returns whether to validate that keys are enabled.

pub fn get_realm(&self) -> &str

Returns the realm for authentication challenges.

Trait Implementations

impl Clone for ApiKeyConfig

fn clone(&self) -> ApiKeyConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKeyConfig

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

Formats the value using the given formatter.

impl Default for ApiKeyConfig

fn default() -> Self

Returns the “default value” for a type.