Struct ApiKeyMethod

pub struct ApiKeyMethod { /* private fields */ }

API key authentication method.

Implementations

impl ApiKeyMethod

pub fn new() -> Self

Create a new API key authentication method.

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

Set the key prefix.

pub fn key_length(self, _length: usize) -> Self

Set the key length (for compatibility with examples).

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

Set the header name.

pub fn key_validator(self, validator: Box<dyn ApiKeyValidator>) -> Self

Set the key validator.

Trait Implementations

impl AuthMethod for ApiKeyMethod

fn name(&self) -> &str

Get the name of this authentication method.

fn authenticate<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, credential: &'life1 Credential, _metadata: &'life2 CredentialMetadata, ) -> Pin<Box<dyn Future<Output = Result<MethodResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Authenticate using the provided credentials.

fn validate_config(&self) -> Result<()>

Validate configuration for this method.

fn supports_refresh(&self) -> bool

Check if this method supports refresh tokens.

fn refresh_token<'life0, 'life1, 'async_trait>( &'life0 self, _refresh_token: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<AuthToken>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Refresh a token if supported.

impl Default for ApiKeyMethod

fn default() -> Self

Returns the “default value” for a type.