Enum ppp::HeaderResult
source · [−]pub enum HeaderResult<'a> {
V1(Result<Header<'a>, BinaryParseError>),
V2(Result<Header<'a>, ParseError>),
}
Expand description
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>)
V2(Result<Header<'a>, ParseError>)
Implementations
sourceimpl<'a> HeaderResult<'a>
impl<'a> HeaderResult<'a>
sourcepub fn parse(input: &'a [u8]) -> 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
sourceimpl<'a> Debug for HeaderResult<'a>
impl<'a> Debug for HeaderResult<'a>
sourceimpl<'a> From<Result<Header<'a>, BinaryParseError>> for HeaderResult<'a>
impl<'a> From<Result<Header<'a>, BinaryParseError>> for HeaderResult<'a>
sourcefn from(result: Result<Header<'a>, BinaryParseError>) -> Self
fn from(result: Result<Header<'a>, BinaryParseError>) -> Self
Converts to this type from the input type.
sourceimpl<'a> From<Result<Header<'a>, ParseError>> for HeaderResult<'a>
impl<'a> From<Result<Header<'a>, ParseError>> for HeaderResult<'a>
sourcefn from(result: Result<Header<'a>, ParseError>) -> Self
fn from(result: Result<Header<'a>, ParseError>) -> Self
Converts to this type from the input type.
sourceimpl<'a> PartialEq<HeaderResult<'a>> for HeaderResult<'a>
impl<'a> PartialEq<HeaderResult<'a>> for HeaderResult<'a>
sourcefn eq(&self, other: &HeaderResult<'a>) -> bool
fn eq(&self, other: &HeaderResult<'a>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &HeaderResult<'a>) -> bool
fn ne(&self, other: &HeaderResult<'a>) -> bool
This method tests for !=
.
sourceimpl<'a> PartialResult for HeaderResult<'a>
impl<'a> PartialResult for HeaderResult<'a>
sourcefn is_incomplete(&self) -> bool
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. Read more
sourcefn is_complete(&self) -> bool
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. Read more
impl<'a> StructuralPartialEq for HeaderResult<'a>
Auto Trait Implementations
impl<'a> RefUnwindSafe for HeaderResult<'a>
impl<'a> Send for HeaderResult<'a>
impl<'a> Sync for HeaderResult<'a>
impl<'a> Unpin for HeaderResult<'a>
impl<'a> UnwindSafe for HeaderResult<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more