Enum BuildError 

#[non_exhaustive]
pub enum BuildError {
    MissingRequiredResponseHeader {
        header: &'static str,
    },
    IllegalCharacter {
        field: &'static str,
        offset: usize,
        byte: u8,
    },
    NotAToken {
        field: &'static str,
    },
}

A message that could not be built.

Every one of these means a caller tried to put something into a message that would have changed its structure — the header-injection family. They are errors rather than silent escaping because a caller that supplies a CRLF in a display name has a bug, and hiding it helps nobody.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MissingRequiredResponseHeader

A response cannot be routed or correlated because the request omitted a header every response must copy (RFC 3261 §8.2.6.1 and §8.2.6.2).

Fields

header: &'static str

The missing header’s canonical name.

IllegalCharacter

A character that would end a line or terminate a string, in a field that must not contain one.

Fields

field: &'static str

Which field.

offset: usize

Where in the value.

byte: u8

The offending byte.

NotAToken

A field that must be a single token is not one.

Fields

field: &'static str

Which field.

Trait Implementations

impl Clone for BuildError

fn clone(&self) -> BuildError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildError

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

Formats the value using the given formatter.

impl Display for BuildError

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

Formats the value using the given formatter.

impl Error for BuildError

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 BuildError

fn eq(&self, other: &BuildError) -> 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 Eq for BuildError

impl StructuralPartialEq for BuildError