Enum ParseError

pub enum ParseError {
    Incomplete(usize),
    Prefix,
    Version(u8),
    Command(u8),
    AddressFamily(u8),
    Protocol(u8),
    Partial(usize, usize),
    InvalidAddresses(usize, usize),
    InvalidTLV(u8, u16),
    Leftovers(usize),
}

An error in parsing a binary PROXY protocol header.

Variants

Incomplete(usize)

Expected header to the protocol prefix plus 4 bytes after the prefix.

Prefix

Expected header to start with a prefix of ‘\r\n\r\n\0\r\nQUIT\n’.

Version(u8)

Expected version to be equal to 2.

Command(u8)

Invalid command. Command must be one of: Local, Proxy.

AddressFamily(u8)

Invalid Address Family. Address Family must be one of: Unspecified, IPv4, IPv6, Unix.

Protocol(u8)

Invalid protocol. Protocol must be one of: Unspecified, Stream, or Datagram.

Partial(usize, usize)

Header does not contain the advertised length of the address information and TLVs.

InvalidAddresses(usize, usize)

Header length of {0} bytes cannot store the {1} bytes required for the address family.

InvalidTLV(u8, u16)

Header is not long enough to contain TLV {0} with length {1}.

Leftovers(usize)

Header contains leftover {0} bytes not accounted for by the address family or TLVs.

Trait Implementations

impl Clone for ParseError

fn clone(&self) -> ParseError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Error for ParseError

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 Hash for ParseError

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ParseError

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

fn is_incomplete(&self) -> bool

Tests whether this Result is incomplete. An action that leads to an incomplete result may have a different result with more bytes. Retrying with the same input will not change the result.

fn is_complete(&self) -> bool

Tests whether this Result is successful or whether the error is terminal. A terminal error will not result in a success even with more bytes. Retrying with the same – or more – input will not change the result.

impl Eq for ParseError

impl StructuralPartialEq for ParseError