Enum proxy_protocol::ProxyHeader

#[non_exhaustive]pub enum ProxyHeader {
    Version1 {
        family: ProxyAddressFamily,
        addresses: ProxyAddresses,
    },
    Version2 {
        command: ProxyCommand,
        transport_protocol: ProxyTransportProtocol,
        addresses: ProxyAddresses,
    },
}

The PROXY header emitted at most once at the start of a new connection.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Version1

This defines the first version specification, known as the “human-readable header format” (section 2.1), and consists of (at most) 107 bytes of data on the wire.

Fields of Version1

family: ProxyAddressFamily

The type of IP-addresses used.

If this is version1::ProxyAddressFamily::Unknown, all the other values are zeroed. In any other case, the rest of the values must have proper values.

addresses: ProxyAddresses

The addresses used to connect to the proxy.

Version2

This defines the second version specification, known as the “binary header format” (section 2.2), and consists of a dynamic amount of bytes on the wire, depending on what information the sender wishes to convey.

Fields of Version2

command: ProxyCommand

The command of this header.

transport_protocol: ProxyTransportProtocol

The protocol over which the information was transferred originally.

addresses: ProxyAddresses

The addresses used to connect to the proxy.

Trait Implementations

impl Clone for ProxyHeader

fn clone(&self) -> ProxyHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProxyHeader

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

Formats the value using the given formatter.

impl Eq for ProxyHeader

impl PartialEq<ProxyHeader> for ProxyHeader

fn eq(&self, other: &ProxyHeader) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ProxyHeader) -> bool

This method tests for !=.

impl StructuralEq for ProxyHeader

impl StructuralPartialEq for ProxyHeader