Struct ApiKey 

pub struct ApiKey(/* private fields */);

The shared API key. Debug never prints the value.

Implementations

impl ApiKey

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

Wrap a key value.

pub fn unset() -> Self

An unset key (every authenticated request is rejected).

pub fn is_configured(&self) -> bool

Whether a non-blank key is configured.

pub fn expose(&self) -> &str

The raw key, for the constant-time comparison only. Never log it.

pub fn len(&self) -> usize

Length of the configured key in bytes.

pub fn is_empty(&self) -> bool

Whether the key is empty.

Trait Implementations

impl Clone for ApiKey

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 ApiKey

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

Formats the value using the given formatter.

impl Default for ApiKey

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ApiKey

impl PartialEq for ApiKey

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ApiKey