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() -> HaProxyLayer

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() -> HaProxyLayer<Udp>

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>) -> HaProxyLayer<P>

Attach a custom bytes payload to the PROXY header.

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

Attach a custom bytes payload to the PROXY header.

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.

Trait Implementations

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

where P: Clone, V: Clone,

fn clone(&self) -> HaProxyLayer<P, V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

where P: Debug, V: Debug,

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

Formats the value using the given formatter.

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

where V: Clone,

type Service = HaProxyService<S, P, V>

The service produced by the layer.

fn layer(&self, inner: S) -> <HaProxyLayer<P, V> as Layer<S>>::Service

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

fn into_layer(self, inner: S) -> <HaProxyLayer<P, V> as Layer<S>>::Service

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