Struct Header

pub struct Header { /* private fields */ }

The PROXY Protocol v1 header.

Implementations

impl Header

pub const MAGIC: &'static str = "PROXY"

PROXY Protocol v1 magic bytes.

pub const fn new(address_pair: AddressPair) -> Self

Creates a new PROXY Protocol v1 header.

pub const fn address_pair(self) -> AddressPair

Returns the address pair of the PROXY Protocol v1 header.

pub fn encode(&self) -> String

Encodes the PROXY Protocol v1 header into a string representation.

pub fn decode(header_bytes: &[u8]) -> Result<Decoded, DecodeError>

Try to decode the PROXY Protocol v1 header from the given buffer.

The caller SHOULD first peek exactly 5 bytes from the network input into a buffer and decode it, to detect the presence of a PROXY Protocol v1 header.

When the buffer is not prefixed with PROXY Protocol v1 header MAGIC, this method returns Decoded::None. The caller MAY reject the connection, or treat the connection as a normal one w/o PROXY Protocol v1 header.

When a PROXY protocol v1 header is detected, Decoded::Partial is returned (this is what we expect, since we only have the MAGIC bytes peeked). The caller SHOULD read from network input into a buffer (may reuse the buffer peeking the MAGIC bytes) until the first \n, then decode it. This method will reject bytes w/o CRLF, and any trailing bytes after CRLF.

The caller MAY ensure that the length of the header_bytes does not exceed the MAXIMUM_LENGTH.

When any error is returned, the caller SHOULD reject the connection.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Display for Header

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

Formats the value using the given formatter.

impl PartialEq for Header

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

impl Eq for Header

impl StructuralPartialEq for Header