Struct Header 

pub struct Header { /* private fields */ }

PROXY protocol v1 header.

Implementations

impl Header

pub fn new(af: AddressFamily, src: SocketAddr, dst: SocketAddr) -> Header

Constructs a new PROXY protocol v1 header.

Panics

Panics if af is not AddressFamily::Inet or AddressFamily::Inet6, or when the supplied socket addresses do not match the address family.

pub fn new_inet(src: SocketAddr, dst: SocketAddr) -> Header

Constructs a new IPv4 PROXY protocol v1 header.

pub fn new_inet6(src: SocketAddr, dst: SocketAddr) -> Header

Constructs a new IPv6 PROXY protocol v1 header.

pub const fn unknown() -> Header

Constructs an UNKNOWN PROXY protocol v1 header.

pub const fn addresses(&self) -> Option<SocketAddresses>

Returns socket address metadata when this is not an UNKNOWN header.

pub fn source_addr(&self) -> Option<SocketAddr>

Returns the source socket address when available.

pub fn destination_addr(&self) -> Option<SocketAddr>

Returns the destination socket address when available.

pub fn write_to(&self, wrt: &mut impl Write) -> Result<(), Error>

Writes this header to an I/O writer.

pub async fn write_to_tokio( &self, wrt: &mut (impl AsyncWrite + Unpin), ) -> Result<(), Error>

Writes this header to a Tokio async writer.

pub fn try_from_bytes( slice: &[u8], ) -> Result<(&[u8], Header), ErrMode<ContextError>>

Attempts to parse a PROXY protocol v1 header from bytes.

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<(), Error>

Formats the value using the given formatter.

impl Display for Header

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

Formats the value using the given formatter.

impl Eq for Header

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