IpServiceBuilder

rama::cli::service::ip

Struct IpServiceBuilder

pub struct IpServiceBuilder<M> { /* private fields */ }

Available on crate features http and net and haproxy and cli only.

Expand description

Builder that can be used to run your own ip Service, echo’ing back the client IP over http or tcp.

Implementations§

impl IpServiceBuilder<Http>

pub fn http() -> Self

Create a new IpServiceBuilder, echoing the IP back over L4.

impl IpServiceBuilder<Transport>

pub fn tcp() -> Self

Create a new IpServiceBuilder, echoing the IP back over L4.

impl<M> IpServiceBuilder<M>

pub fn with_concurrent(self, limit: usize) -> Self

set the number of concurrent connections to allow

pub fn set_concurrent(&mut self, limit: usize) -> &mut Self

set the number of concurrent connections to allow

pub fn with_timeout(self, timeout: Duration) -> Self

set the timeout in seconds for each connection

pub fn set_timeout(&mut self, timeout: Duration) -> &mut Self

set the timeout in seconds for each connection

pub fn maybe_with_forward(self, maybe_kind: Option<ForwardKind>) -> Self

maybe enable support for one of the following “forward” headers or protocols

Supported headers:

Forwarded (“for=”), X-Forwarded-For

X-Client-IP Client-IP, X-Real-IP

CF-Connecting-IP, True-Client-IP

Or using HaProxy protocol.

pub fn maybe_set_forward( &mut self, maybe_kind: Option<ForwardKind>, ) -> &mut Self

maybe enable support for one of the following “forward” headers or protocols

Supported headers:

Forwarded (“for=”), X-Forwarded-For

X-Client-IP Client-IP, X-Real-IP

CF-Connecting-IP, True-Client-IP

Or using HaProxy protocol.

pub fn with_forward(self, maybe_kind: ForwardKind) -> Self

maybe enable support for one of the following “forward” headers or protocols

Supported headers:

Forwarded (“for=”), X-Forwarded-For

X-Client-IP Client-IP, X-Real-IP

CF-Connecting-IP, True-Client-IP

Or using HaProxy protocol.

pub fn set_forward(&mut self, maybe_kind: ForwardKind) -> &mut Self

maybe enable support for one of the following “forward” headers or protocols

Supported headers:

Forwarded (“for=”), X-Forwarded-For

X-Client-IP Client-IP, X-Real-IP

CF-Connecting-IP, True-Client-IP

Or using HaProxy protocol.

pub fn without_forward(self) -> Self

maybe enable support for one of the following “forward” headers or protocols

Supported headers:

Forwarded (“for=”), X-Forwarded-For

X-Client-IP Client-IP, X-Real-IP

CF-Connecting-IP, True-Client-IP

Or using HaProxy protocol.

pub fn unset_forward(&mut self) -> &mut Self

maybe enable support for one of the following “forward” headers or protocols

Supported headers:

Forwarded (“for=”), X-Forwarded-For

X-Client-IP Client-IP, X-Real-IP

CF-Connecting-IP, True-Client-IP

Or using HaProxy protocol.

pub fn maybe_with_tls_server_config(self, cfg: Option<ServerConfig>) -> Self

Available on crate features rustls or boring only.

define a tls server cert config to be used for tls terminaton by the IP service.

pub fn maybe_set_tls_server_config( &mut self, cfg: Option<ServerConfig>, ) -> &mut Self

Available on crate features rustls or boring only.

define a tls server cert config to be used for tls terminaton by the IP service.

pub fn with_tls_server_config(self, cfg: ServerConfig) -> Self

Available on crate features rustls or boring only.

define a tls server cert config to be used for tls terminaton by the IP service.

pub fn set_tls_server_config(&mut self, cfg: ServerConfig) -> &mut Self

Available on crate features rustls or boring only.

define a tls server cert config to be used for tls terminaton by the IP service.

pub fn without_tls_server_config(self) -> Self

Available on crate features rustls or boring only.

define a tls server cert config to be used for tls terminaton by the IP service.

pub fn unset_tls_server_config(&mut self) -> &mut Self

Available on crate features rustls or boring only.

define a tls server cert config to be used for tls terminaton by the IP service.

impl IpServiceBuilder<Http>

pub fn build( self, executor: Executor, ) -> Result<impl Service<TcpStream, Response = (), Error = Infallible>, BoxError>

build a tcp service ready to echo the client IP back

impl IpServiceBuilder<Transport>

pub fn build( self, ) -> Result<impl Service<TcpStream, Response = (), Error = Infallible>, BoxError>

build a tcp service ready to echo client IP back

Trait Implementations§

impl<M: Clone> Clone for IpServiceBuilder<M>

fn clone(&self) -> IpServiceBuilder<M>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<M: Debug> Debug for IpServiceBuilder<M>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<M> Freeze for IpServiceBuilder<M>

impl<M> !RefUnwindSafe for IpServiceBuilder<M>

impl<M> Send for IpServiceBuilder<M>

impl<M> Sync for IpServiceBuilder<M>

impl<M> Unpin for IpServiceBuilder<M>

impl<M> !UnwindSafe for IpServiceBuilder<M>

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<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<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> 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: 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: 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> 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 = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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