Struct Header

pub struct Header { /* private fields */ }

The PROXY Protocol v2 header.

For encoding and decoding stuffs, please refer to codec::HeaderEncoder and codec::HeaderDecoder.

Implementations

impl Header

pub const MAGIC: &'static [u8; 12] = b"\r\n\r\n\x00\r\nQUIT\n"

The magic bytes that identify the PROXY Protocol v2 header.

pub const fn new_local() -> Self

Creates a new Header with Command::Local

pub const fn new_proxy(protocol: Protocol, address_pair: AddressPair) -> Self

Creates a new Header with Command::Proxy

pub const fn command(&self) -> &Command

Returns the command of the header.

pub const fn protocol(&self) -> &Protocol

Returns the protocol of the header.

pub const fn address_pair(&self) -> &AddressPair

Returns the address pair of the header.

pub fn encode(&self) -> Encoded

See HeaderEncoder::encode.

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

See HeaderDecoder::decode.

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 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 Eq for Header

impl StructuralPartialEq for Header