Struct Header 

pub struct Header { /* private fields */ }

PROXY protocol v2 header.

Implementations

impl Header

pub fn new( command: Command, transport_protocol: TransportProtocol, address_family: AddressFamily, src: impl Into<SocketAddr>, dst: impl Into<SocketAddr>, ) -> Header

Constructs a new PROXY protocol v2 header.

Panics

Panics if address_family does not match src and dst.

pub fn new_unspecified(command: Command) -> Header

Constructs a new header without address information.

pub fn new_unix( command: Command, transport_protocol: TransportProtocol, source: [u8; 108], destination: [u8; 108], ) -> Header

Constructs a new UNIX socket header.

pub fn new_tcp_ipv4_proxy( src: impl Into<SocketAddr>, dst: impl Into<SocketAddr>, ) -> Header

Constructs a new TCP/IPv4 PROXY command header.

pub fn new_tcp_ipv6_proxy( src: impl Into<SocketAddr>, dst: impl Into<SocketAddr>, ) -> Header

Constructs a new TCP/IPv6 PROXY command header.

pub const fn command(&self) -> Command

Returns the header command.

pub const fn transport_protocol(&self) -> TransportProtocol

Returns the transport protocol.

pub fn address_family(&self) -> AddressFamily

Returns the address family.

pub const fn addresses(&self) -> &Addresses

Returns the encoded address information.

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

Returns the source socket address for IP headers.

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

Returns the destination socket address for IP headers.

pub fn tlvs(&self) -> impl Iterator<Item = (u8, &[u8])>

Returns raw TLVs as (type, value) pairs.

pub fn typed_tlv<T>(&self) -> Option<T>

where T: Tlv,

Returns the first TLV that decodes as T.

pub fn add_tlv(&mut self, typ: u8, value: impl AsRef<[u8]>)

Adds a raw TLV entry.

pub fn add_typed_tlv<T>(&mut self, tlv: T)

where T: Tlv,

Adds a typed TLV entry.

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 to_vec(&self) -> Vec<u8>

Serializes this header to bytes.

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

Attempts to parse a PROXY protocol v2 header from bytes.

pub fn has_tlv<T>(&self) -> bool

where T: Tlv,

Returns true when this header contains a TLV with type T.

pub fn add_crc32c_checksum(&mut self)

Calculates and adds a crc32c TLV to the PROXY header.

Uses method defined in spec.

If this is not called last thing it will be wrong.

pub fn validate_crc32c_tlv(&self) -> Option<bool>

Validates the CRC32c TLV, returning None when no CRC32c TLV is present.

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 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