Struct HaProxyLayer 

pub struct HaProxyLayer<P = Tcp, V = Two> { /* private fields */ }

Layer to encode and write the HaProxy Protocol, as a client on the connected stream.

This connector should in most cases happen as the first thing after establishing the connection.

Implementations

impl HaProxyLayer

pub fn tcp() -> Self

Create a new HaProxyLayer for the TCP protocol (default).

This is in the PROXY spec referred to as:

• TCP4 (for IPv4, v1)
• TCP6 (for IPv6, v1)
• Stream (v2)

pub fn v1(self) -> HaProxyLayer<Tcp, One>

Use version one of PROXY protocol, instead of the default version two.

Version one makes use of a less advanced text protocol, instead the more advanced binary v2 protocol.

Use this only if you have no control over a v1-only server.

impl HaProxyLayer<Udp>

pub fn udp() -> Self

Create a new HaProxyLayer for the UDP protocol, instead of the default TCP protocol.

This is in the PROXY spec referred to as:

• Datagram (v2)

impl<P> HaProxyLayer<P>

pub fn with_payload(self, payload: impl Into<Bytes>) -> Self

Attach a raw bytes payload to the PROXY v2 header, written verbatim after the address block.

Wire-format hazard. Spec section 2.2 says everything after the address block is a sequence of TLVs. If your bytes are not valid TLV encoding, conforming receivers (including rama’s server) will either reject the connection or mis-parse the data. Prefer [Self::tlv] for anything spec-compliant; treat payload as a raw escape hatch for testing.

In particular, combining payload with [Self::crc32c] is rejected at send time: the CRC32C TLV would be appended after the raw payload, which means the receiver would try to interpret the payload as TLVs, fail, and the CRC would be computed over a header the receiver can’t validate. Use TLVs instead.

NOTE this is only possible in Version two of the PROXY Protocol. In case you downgrade this HaProxyLayer to version one later using Self::v1 this payload will be dropped.

pub fn set_payload(&mut self, payload: impl Into<Bytes>) -> &mut Self

Attach a raw bytes payload to the PROXY v2 header, written verbatim after the address block.

Wire-format hazard. Spec section 2.2 says everything after the address block is a sequence of TLVs. If your bytes are not valid TLV encoding, conforming receivers (including rama’s server) will either reject the connection or mis-parse the data. Prefer [Self::tlv] for anything spec-compliant; treat payload as a raw escape hatch for testing.

In particular, combining payload with [Self::crc32c] is rejected at send time: the CRC32C TLV would be appended after the raw payload, which means the receiver would try to interpret the payload as TLVs, fail, and the CRC would be computed over a header the receiver can’t validate. Use TLVs instead.

NOTE this is only possible in Version two of the PROXY Protocol. In case you downgrade this HaProxyLayer to version one later using Self::v1 this payload will be dropped.

pub fn with_tlv(self, kind: Type, value: impl Into<Bytes>) -> Self

Attach a Type-Length-Value entry to the emitted v2 header.

Call this once per TLV; entries are written in insertion order. Queuing a v2::Type::CRC32C entry here is rejected at send time — a CRC value must be computed over the final header bytes, so use [Self::crc32c] instead.

NOTE this is only possible in Version two of the PROXY Protocol. On downgrade to v1 via Self::v1 all TLVs are dropped.

pub fn set_tlv(&mut self, kind: Type, value: impl Into<Bytes>) -> &mut Self

Attach a Type-Length-Value entry to the emitted v2 header.

Call this once per TLV; entries are written in insertion order. Queuing a v2::Type::CRC32C entry here is rejected at send time — a CRC value must be computed over the final header bytes, so use [Self::crc32c] instead.

NOTE this is only possible in Version two of the PROXY Protocol. On downgrade to v1 via Self::v1 all TLVs are dropped.

pub fn with_crc32c(self, enabled: bool) -> Self

Toggle automatic emission of a valid PP2_TYPE_CRC32C TLV.

When enabled, the CRC is computed over the final header (with the CRC field zeroed during computation, per spec section 2.2.5) and appended as the last TLV. Receivers that enforce CRC verification (rama’s server default) will accept the header.

Incompatible with [Self::payload]: setting both is rejected at send time because the raw payload would sit between the TLVs and the CRC32C TLV, which standards-conforming receivers cannot parse.

NOTE this is only possible in Version two of the PROXY Protocol.

pub fn set_crc32c(&mut self, enabled: bool) -> &mut Self

Toggle automatic emission of a valid PP2_TYPE_CRC32C TLV.

When enabled, the CRC is computed over the final header (with the CRC field zeroed during computation, per spec section 2.2.5) and appended as the last TLV. Receivers that enforce CRC verification (rama’s server default) will accept the header.

Incompatible with [Self::payload]: setting both is rejected at send time because the raw payload would sit between the TLVs and the CRC32C TLV, which standards-conforming receivers cannot parse.

NOTE this is only possible in Version two of the PROXY Protocol.

Trait Implementations

impl<P: Clone, V: Clone> Clone for HaProxyLayer<P, V>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug, V: Debug> Debug for HaProxyLayer<P, V>

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

Formats the value using the given formatter.

impl<S, P, V: Clone> Layer<S> for HaProxyLayer<P, V>

type Service = HaProxyService<S, P, V>

The service produced by the layer.

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service.

fn into_layer(self, inner: S) -> Self::Service

Same as layer but consuming self after the service was created.