Struct ApiKeyAuth 

pub struct ApiKeyAuth { /* private fields */ }

Implementations

impl ApiKeyAuth

pub fn new(key: impl Into<String>) -> Self

Creates authentication middleware with a single static API key.

By default, the key is extracted from the X-API-Key header.

pub fn from_keys<I>(keys: I) -> Self

where I: IntoIterator, I::Item: Into<String>,

Creates authentication middleware with multiple static API keys.

pub fn with_verify<F>(f: F) -> Self

where F: Fn(&str) -> bool + Send + Sync + 'static,

Creates authentication middleware with a custom verification function.

pub fn from_keys_with_verify<I, F>(keys: I, f: F) -> Self

where I: IntoIterator, I::Item: Into<String>, F: Fn(&str) -> bool + Send + Sync + 'static,

Creates authentication with both static keys and custom verification.

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

Sets the location where the API key should be extracted from.

pub fn header_name(self, name: &'static str) -> Self

Sets a custom header name for API key extraction.

This is a convenience method equivalent to .location(ApiKeyLocation::Header(name)).

pub fn query_param(self, name: &'static str) -> Self

Sets a query parameter name for API key extraction.

This is a convenience method equivalent to .location(ApiKeyLocation::Query(name)).

Trait Implementations

impl IntoMiddleware for ApiKeyAuth

fn into_middleware( self, ) -> impl Fn(Request, Next) -> Pin<Box<dyn Future<Output = Response> + Send + 'static>> + Clone + Send + Sync + 'static

Converts the API key authentication configuration into middleware.