Enum Error

pub enum Error {
    AbsentHeader {
        header_name: HeaderName,
    },
    NonAsciiHeaderValue {
        header_name: HeaderName,
    },
    MalformedHeaderValue {
        header_name: HeaderName,
        header_value: String,
    },
    SingleHeaderRequired {
        header_name: HeaderName,
    },
    ForwardedNoFor {
        header_value: String,
    },
    ForwardedObfuscated {
        header_value: String,
    },
    ForwardedUnknown {
        header_value: String,
    },
}

Errors that can occur during IP extraction

Variants

AbsentHeader

The IP-related header is missing

Fields

header_name: HeaderName

Header name

NonAsciiHeaderValue

Header value contains not only visible ASCII characters

Fields

header_name: HeaderName

Header name

MalformedHeaderValue

Header value has an unexpected format

Fields

header_name: HeaderName

Header name

header_value: String

Header value

SingleHeaderRequired

Multiple occurrences of a header required to occur only once found

According to the HTTP/1.1 specification (RFC 7230, Section 3.2.2):

A sender MUST NOT generate multiple header fields with the same field name in a message unless either the entire field value for that header field is defined as a comma-separated list …

Fields

header_name: HeaderName

Header name

ForwardedNoFor

Available on crate feature forwarded-header only.

Forwarded header doesn’t contain for directive

Fields

header_value: String

Header value

ForwardedObfuscated

Available on crate feature forwarded-header only.

RFC 7239 allows to obfuscate IPs

Fields

header_value: String

Header value

ForwardedUnknown

Available on crate feature forwarded-header only.

RFC 7239 allows unknown identifiers

Fields

header_value: String

Header value

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Error