Enum ppp::HeaderResult

pub enum HeaderResult<'a> {
    V1(Result<Header<'a>, BinaryParseError>),
    V2(Result<Header<'a>, ParseError>),
}

An enumeration of the supported header version’s parse results. Useful for parsing either version 1 or version 2 of the PROXY protocol.

Examples

use ppp::{HeaderResult, PartialResult, v1, v2};

let input = "PROXY UNKNOWN\r\n";
let header = HeaderResult::parse(input.as_bytes());

assert_eq!(header, Ok(v1::Header::new(input, v1::Addresses::Unknown)).into());

Variants

V1(Result<Header<'a>, BinaryParseError>)

Tuple Fields

0: Result<Header<'a>, BinaryParseError>

V2(Result<Header<'a>, ParseError>)

Tuple Fields

0: Result<Header<'a>, ParseError>

Implementations

impl<'a> HeaderResult<'a>

pub fn parse(input: &'a [u8]) -> HeaderResult<'a>

Parses a PROXY protocol version 2 Header. If the input is not a valid version 2 Header, attempts to parse a version 1 Header.

Trait Implementations

impl<'a> Debug for HeaderResult<'a>

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

Formats the value using the given formatter.

impl<'a> From<Result<Header<'a>, BinaryParseError>> for HeaderResult<'a>

fn from(result: Result<Header<'a>, BinaryParseError>) -> Self

Performs the conversion.

impl<'a> From<Result<Header<'a>, ParseError>> for HeaderResult<'a>

fn from(result: Result<Header<'a>, ParseError>) -> Self

Performs the conversion.

impl<'a> PartialEq<HeaderResult<'a>> for HeaderResult<'a>

fn eq(&self, other: &HeaderResult<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HeaderResult<'a>) -> bool

This method tests for !=.

impl<'a> PartialResult for HeaderResult<'a>

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<'a> StructuralPartialEq for HeaderResult<'a>