Struct rama::proxy::haproxy::client::HaProxyService

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

Service 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<S> HaProxyService<S>

pub fn tcp(inner: S) -> HaProxyService<S>

Create a new HaProxyService 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) -> HaProxyService<S, 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<S> HaProxyService<S, Udp>

pub fn udp(inner: S) -> HaProxyService<S, Udp>

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

This is in the PROXY spec referred to as:

• Datagram (v2)

impl<S, P> HaProxyService<S, P>

pub fn payload(self, payload: Vec<u8>) -> HaProxyService<S, 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: Vec<u8>) -> &mut HaProxyService<S, 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<S, P, V> Clone for HaProxyService<S, P, V>

where S: Clone, V: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S, P, V> Debug for HaProxyService<S, P, V>

where S: Debug, V: Debug,

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

Formats the value using the given formatter.

impl<S, P, State, Request, T> Service<State, Request> for HaProxyService<S, P>

where S: Service<State, Request, Response = EstablishedClientConnection<T, State, Request>>, <S as Service<State, Request>>::Error: Into<Box<dyn Error + Sync + Send>>, P: Protocol + Send + 'static, State: Clone + Send + Sync + 'static, Request: Send + 'static, T: Stream + Unpin,

type Response = EstablishedClientConnection<T, State, Request>

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request, ) -> Result<<HaProxyService<S, P> as Service<State, Request>>::Response, <HaProxyService<S, P> as Service<State, Request>>::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S, P, State, Request> Service<State, Request> for HaProxyService<S, P, One>

where S: ConnectorService<State, Request>, <S as ConnectorService<State, Request>>::Connection: Stream + Unpin, <S as ConnectorService<State, Request>>::Error: Into<Box<dyn Error + Sync + Send>>, P: Send + 'static, State: Clone + Send + Sync + 'static, Request: Send + 'static,

type Response = EstablishedClientConnection<<S as ConnectorService<State, Request>>::Connection, State, Request>

The type of response returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, ctx: Context<State>, req: Request, ) -> Result<<HaProxyService<S, P, One> as Service<State, Request>>::Response, <HaProxyService<S, P, One> as Service<State, Request>>::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.