Skip to main content

HaProxyService

rama::proxy::haproxy::server

Struct HaProxyService

pub struct HaProxyService<S, Pol = PeekPolicy> { /* private fields */ }

Available on crate feature haproxy only.

Expand description

Service to decode the HaProxy Protocol

This service will decode the HaProxy Protocol header and pass the decoded information to the inner service.

Implementations§

impl<S> HaProxyService<S>

pub const fn new(inner: S) -> HaProxyService<S>

Create a new HaProxyService with the given inner service.

impl<S, Pol> HaProxyService<S, Pol>

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

pub fn with_peek(self, value: bool) -> HaProxyService<S, Pol>

Instruct HaProxyService to peek prior to comitting to the HaProxy protocol.

Doing so makes it possible to support traffic with or without the use of that data. This can be useful to run services locally (not behind a loadbalancer) as well as in the the cloud (production, behind a loadbalancer).

pub fn set_peek(&mut self, value: bool) -> &mut HaProxyService<S, Pol>

Instruct HaProxyService to peek prior to comitting to the HaProxy protocol.

Doing so makes it possible to support traffic with or without the use of that data. This can be useful to run services locally (not behind a loadbalancer) as well as in the the cloud (production, behind a loadbalancer).

pub fn maybe_with_peek_timeout( self, peek_timeout: Option<Duration>, ) -> HaProxyService<S, Pol>

Set the maximum time spent peeking for a PROXY header, see Self::with_peek.

A timeout is inconclusive. Use Self::with_peek_policy to choose whether it treats the input as not PROXY, rejects the connection or keeps waiting.

pub fn maybe_set_peek_timeout( &mut self, peek_timeout: Option<Duration>, ) -> &mut HaProxyService<S, Pol>

Set the maximum time spent peeking for a PROXY header, see Self::with_peek.

A timeout is inconclusive. Use Self::with_peek_policy to choose whether it treats the input as not PROXY, rejects the connection or keeps waiting.

pub fn with_peek_timeout(self, peek_timeout: Duration) -> HaProxyService<S, Pol>

Set the maximum time spent peeking for a PROXY header, see Self::with_peek.

A timeout is inconclusive. Use Self::with_peek_policy to choose whether it treats the input as not PROXY, rejects the connection or keeps waiting.

pub fn set_peek_timeout( &mut self, peek_timeout: Duration, ) -> &mut HaProxyService<S, Pol>

Set the maximum time spent peeking for a PROXY header, see Self::with_peek.

A timeout is inconclusive. Use Self::with_peek_policy to choose whether it treats the input as not PROXY, rejects the connection or keeps waiting.

pub fn without_peek_timeout(self) -> HaProxyService<S, Pol>

Set the maximum time spent peeking for a PROXY header, see Self::with_peek.

A timeout is inconclusive. Use Self::with_peek_policy to choose whether it treats the input as not PROXY, rejects the connection or keeps waiting.

pub fn unset_peek_timeout(&mut self) -> &mut HaProxyService<S, Pol>

Set the maximum time spent peeking for a PROXY header, see Self::with_peek.

A timeout is inconclusive. Use Self::with_peek_policy to choose whether it treats the input as not PROXY, rejects the connection or keeps waiting.

pub fn with_peek_policy<Pol2>( self, peek_policy: Pol2, ) -> HaProxyService<S, Pol2>

Set how a peek timeout or PeekInterrupt is handled, using a static PeekPolicy or a PeekPolicyProvider that selects one per input.

Defaults to PeekPolicy::FAIL_OPEN, under which a cutoff treats the input as not PROXY.

pub fn with_strictness(self, value: HaProxyStrictness) -> HaProxyService<S, Pol>

Override the strictness configuration applied to incoming PROXY headers.

pub fn set_strictness( &mut self, value: HaProxyStrictness, ) -> &mut HaProxyService<S, Pol>

Override the strictness configuration applied to incoming PROXY headers.

pub fn with_forwarded_selection_policy( self, policy: ForwardedSelectionPolicy, ) -> HaProxyService<S, Pol>

Install this ForwardedSelectionPolicy, which selects the client element of the Forwarded chain, overwriting one set already unless keeping existing ones.

pub fn set_forwarded_selection_policy( &mut self, policy: ForwardedSelectionPolicy, ) -> &mut HaProxyService<S, Pol>

Install this ForwardedSelectionPolicy, which selects the client element of the Forwarded chain, overwriting one set already unless keeping existing ones.

pub fn with_keep_existing_selection_policy( self, keep: bool, ) -> HaProxyService<S, Pol>

Install the ForwardedSelectionPolicy only where none is set yet.

pub fn set_keep_existing_selection_policy( &mut self, keep: bool, ) -> &mut HaProxyService<S, Pol>

Install the ForwardedSelectionPolicy only where none is set yet.

Trait Implementations§

impl<S, Pol> Clone for HaProxyService<S, Pol>
where S: Clone, Pol: Clone,

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

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl<S, Pol> Debug for HaProxyService<S, Pol>
where S: Debug, Pol: Debug,

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

Formats the value using the given formatter. Read more

impl<S, Pol> ExtensionsRef for HaProxyService<S, Pol>
where S: ExtensionsRef,

fn extensions(&self) -> &Extensions

Get reference to the underlying Extensions store

impl<S, IO, Pol> Service<IO> for HaProxyService<S, Pol>
where S: Service<PrefixedIo<HeapReader, IO>>, <S as Service<PrefixedIo<HeapReader, IO>>>::Error: Into<Box<dyn Error + Sync + Send>>, IO: Io + Unpin + ExtensionsRef, Pol: PeekPolicyProvider<IO>,

type Output = <S as Service<PrefixedIo<HeapReader, IO>>>::Output

The type of the output returned by the service.

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

The type of error returned by the service.

async fn serve( &self, stream: IO, ) -> Result<<HaProxyService<S, Pol> as Service<IO>>::Output, <HaProxyService<S, Pol> as Service<IO>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

impl<S, Pol> Forget for HaProxyService<S, Pol>

impl<S, Pol> Freeze for HaProxyService<S, Pol>
where S: Freeze, Pol: Freeze,

impl<S, Pol> RefUnwindSafe for HaProxyService<S, Pol>
where S: RefUnwindSafe, Pol: RefUnwindSafe,

impl<S, Pol> Send for HaProxyService<S, Pol>
where S: Send, Pol: Send,

impl<S, Pol> Sync for HaProxyService<S, Pol>
where S: Sync, Pol: Sync,

impl<S, Pol> Unpin for HaProxyService<S, Pol>
where S: Unpin, Pol: Unpin,

impl<S, Pol> UnsafeUnpin for HaProxyService<S, Pol>
where S: UnsafeUnpin, Pol: UnsafeUnpin,

impl<S, Pol> UnwindSafe for HaProxyService<S, Pol>
where S: UnwindSafe, Pol: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<S, Input, Connection> ConnectorService<Input> for S
where S: Service<Input, Output = EstablishedClientConnection<Connection, Input>>, <S as Service<Input>>::Error: Into<ConnectionError>, Connection: Send + ExtensionsRef,

type Connection = Connection

Connection returned by the ConnectorService

fn connect( &self, input: Input, ) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<Input>>::Connection, Input>, ConnectionError>> + Send

Establish a connection, which often involves some kind of handshake, or connection revival. Read more

impl<T> ForwardedClientExt for T
where T: ExtensionsRef + ?Sized,

fn forwarded_client(&self) -> Option<&ForwardedElement>

The element describing the client.

fn forwarded_client_ip(&self) -> Option<IpAddr>

The client’s IP, from its for node.

fn forwarded_client_socket_addr(&self) -> Option<SocketAddress>

The client’s IP and port, from its for node.

fn forwarded_client_host(&self) -> Option<&ForwardedAuthority>

The host the client asked for.

fn forwarded_client_proto(&self) -> Option<ForwardedProtocol>

The protocol the client used.

fn forwarded_client_version(&self) -> Option<ForwardedVersion>

The HTTP version the client used.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T> FutureExt for T

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T, U> RamaFrom<T> for U
where U: From<T>,

fn rama_from(value: T) -> U

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

fn rama_into(self) -> U

impl<T, U> RamaTryFrom<T> for U
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more