Struct ProxyHeader 

#[non_exhaustive]
pub struct ProxyHeader<'a> {
    pub version: u8,
    pub command: ProxyCommand,
    pub transport: ProxyTransport,
    pub source: Option<ProxyAddress<'a>>,
    pub destination: Option<ProxyAddress<'a>>,
    pub tlvs: Tlvs<'a>,
    /* private fields */
}

Available on crate feature proxy only.

A parsed PROXY header, borrowing from the bytes it was parsed from.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

version: u8

1 or 2.

command: ProxyCommand

Proxy, or Local (a connection made by the proxy itself, such as a health check: keep the socket’s own addresses).

transport: ProxyTransport

The transport of the proxied connection.

source: Option<ProxyAddress<'a>>

The real client; None for LOCAL, v1 UNKNOWN, and v2 UNSPEC.

destination: Option<ProxyAddress<'a>>

The address the client connected to; None as for source.

tlvs: Tlvs<'a>

The v2 TLVs (empty for v1); NOOP entries are skipped.

Implementations

impl<'a> ProxyHeader<'a>

pub fn alpn(&self) -> Option<&'a [u8]>

The ALPN protocol the proxy negotiated with the client (TLV 0x01).

pub fn authority(&self) -> Option<&'a str>

The authority (host name) the client asked for (TLV 0x02), if UTF-8.

pub fn unique_id(&self) -> Option<&'a [u8]>

The proxy’s unique connection id (TLV 0x05, at most 128 bytes).

pub fn ssl(&self) -> Option<ProxySsl<'a>>

The SSL facts (TLV 0x20).

pub fn network_namespace(&self) -> Option<&'a [u8]>

The network namespace (TLV 0x30).

pub fn crc_checked(&self) -> bool

Whether a CRC32C TLV was present and matched.

pub fn to_facts(&self) -> ProxyFacts

The facts net-io keeps after the header’s bytes are gone (fixed arrays; a value longer than its array is left out).

Trait Implementations

impl<'a> Clone for ProxyHeader<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ProxyHeader<'a>

impl<'a> Debug for ProxyHeader<'a>

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

Formats the value using the given formatter.