Enum ApiKeyHeaderError 

pub enum ApiKeyHeaderError {
    MissingHeader {
        header_name: String,
    },
    EmptyKey {
        header_name: String,
    },
    InvalidUtf8 {
        header_name: String,
    },
}

Error returned when API key header extraction fails.

Variants

MissingHeader

The API key header is missing.

Fields

header_name: String

Name of the expected header.

EmptyKey

The API key header is empty.

Fields

header_name: String

Name of the header.

InvalidUtf8

The header value is not valid UTF-8.

Fields

header_name: String

Name of the header.

Implementations

impl ApiKeyHeaderError

pub fn missing_header(header_name: impl Into<String>) -> Self

Create a missing header error.

pub fn empty_key(header_name: impl Into<String>) -> Self

Create an empty key error.

pub fn invalid_utf8(header_name: impl Into<String>) -> Self

Create an invalid UTF-8 error.

pub fn detail(&self) -> String

Get a human-readable description of this error.

Trait Implementations

impl Clone for ApiKeyHeaderError

fn clone(&self) -> ApiKeyHeaderError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKeyHeaderError

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

Formats the value using the given formatter.

impl Display for ApiKeyHeaderError

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

Formats the value using the given formatter.

impl Error for ApiKeyHeaderError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl IntoResponse for ApiKeyHeaderError

fn into_response(self) -> Response

Convert into a response.