Struct HeaderEncoder

pub struct HeaderEncoder<Stage = Magic> { /* private fields */ }

Encoder for a PROXY Protocol v2 header.

Implementations

impl HeaderEncoder<Magic>

pub fn encode(header: &Header) -> Encoded

Encodes a PROXY Protocol v2 header from the given Header.

This returns a Encoded which can be finalized to produce the encoded header bytes. To write some extensions to the header, use the methods like Encoded::write_ext_alpn, etc.

impl HeaderEncoder<Finished>

pub fn write_ext_alpn(self, alpn: &[u8]) -> Result<Self, EncodeError>

Writes the ALPN extension bytes to the header.

See ExtensionType::ALPN.

pub fn write_ext_authority(self, authority: &[u8]) -> Result<Self, EncodeError>

Writes the Authority extension bytes to the header.

See ExtensionType::Authority.

pub fn write_ext_no_op(self, padding: u16) -> Result<Self, EncodeError>

Writes padding zeros to the header, the total size is 3 + padding.

See ExtensionType::NoOp.

pub fn write_ext_unique_id(self, payload: &[u8]) -> Result<Self, EncodeError>

Writes the UniqueId extension bytes to the header.

See ExtensionType::UniqueId.

pub fn write_ext_network_namespace( self, payload: &[u8], ) -> Result<Self, EncodeError>

Writes the NetworkNamespace extension bytes to the header.

See ExtensionType::NetworkNamespace.

pub fn write_ext_custom(self, extension: ExtensionRef<'_>) -> Self

Writes a custom extension to the header.

Notice: will not check if the typ is valid.

pub fn finish_with_crc32c(self) -> Result<Vec<u8>, EncodeError>

Calculates and writes the CRC32C extension bytes to the header and finalizes the header encoding.

pub fn finish(self) -> Result<Vec<u8>, EncodeError>

Finalizes the header encoding.

Trait Implementations

impl<Stage: Debug> Debug for HeaderEncoder<Stage>

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

Formats the value using the given formatter.