Struct rama::proxy::ProxyDBService
pub struct ProxyDBService<S, D, P, F> { /* private fields */ }
Expand description
A Service
which selects a Proxy
based on the given Context
.
Depending on the ProxyFilterMode
the selection proxies might be optional,
or use the default ProxyFilter
in case none is defined.
A predicate can be used to provide additional filtering on the found proxies,
that otherwise did match the used ProxyFilter
.
See the crate docs for examples and more info on the usage of this service.
Implementations§
§impl<S, D> ProxyDBService<S, D, bool, ()>
impl<S, D> ProxyDBService<S, D, bool, ()>
pub const fn new(inner: S, db: D) -> ProxyDBService<S, D, bool, ()>
pub const fn new(inner: S, db: D) -> ProxyDBService<S, D, bool, ()>
Create a new ProxyDBService
with the given inner Service
and ProxyDB
.
§impl<S, D, P, F> ProxyDBService<S, D, P, F>
impl<S, D, P, F> ProxyDBService<S, D, P, F>
pub fn filter_mode(self, mode: ProxyFilterMode) -> ProxyDBService<S, D, P, F>
pub fn filter_mode(self, mode: ProxyFilterMode) -> ProxyDBService<S, D, P, F>
Set a ProxyFilterMode
to define the behaviour surrounding
ProxyFilter
usage, e.g. if a proxy filter is required to be available or not,
or what to do if it is optional and not available.
pub fn set_filter_mode(
&mut self,
mode: ProxyFilterMode,
) -> &mut ProxyDBService<S, D, P, F>
pub fn set_filter_mode( &mut self, mode: ProxyFilterMode, ) -> &mut ProxyDBService<S, D, P, F>
Set a ProxyFilterMode
to define the behaviour surrounding
ProxyFilter
usage, e.g. if a proxy filter is required to be available or not,
or what to do if it is optional and not available.
pub const fn preserve_proxy(self, preserve: bool) -> ProxyDBService<S, D, P, F>
pub const fn preserve_proxy(self, preserve: bool) -> ProxyDBService<S, D, P, F>
Define whether or not an existing ProxyAddress
(in the Context
)
should be overwritten or not. By default preserve=false
,
meaning we will overwrite the proxy address in case we selected one now.
NOTE even when preserve=false
it might still be that there’s
a ProxyAddress
in case it was set by a previous layer.
pub fn set_preserve_proxy(
&mut self,
preserve: bool,
) -> &mut ProxyDBService<S, D, P, F>
pub fn set_preserve_proxy( &mut self, preserve: bool, ) -> &mut ProxyDBService<S, D, P, F>
Define whether or not an existing ProxyAddress
(in the Context
)
should be overwritten or not. By default preserve=false
,
meaning we will overwrite the proxy address in case we selected one now.
NOTE even when preserve=false
it might still be that there’s
a ProxyAddress
in case it was set by a previous layer.
pub fn select_predicate<Predicate>(
self,
p: Predicate,
) -> ProxyDBService<S, D, Predicate, F>
pub fn select_predicate<Predicate>( self, p: Predicate, ) -> ProxyDBService<S, D, Predicate, F>
Set a ProxyQueryPredicate
that will be used
to possibly filter out proxies that according to the filters are correct,
but not according to the predicate.
pub fn username_formatter<Formatter>(
self,
f: Formatter,
) -> ProxyDBService<S, D, P, Formatter>
pub fn username_formatter<Formatter>( self, f: Formatter, ) -> ProxyDBService<S, D, P, Formatter>
Set a UsernameFormatter
that will be used to format
the username based on the selected Proxy
. This is required
in case the proxy is a router that accepts or maybe even requires
username labels to configure proxies further down/up stream.
pub fn into_inner(self) -> S
pub fn into_inner(self) -> S
Consumes self
, returning the underlying service.
Trait Implementations§
§impl<S, D, P, F> Clone for ProxyDBService<S, D, P, F>
impl<S, D, P, F> Clone for ProxyDBService<S, D, P, F>
§fn clone(&self) -> ProxyDBService<S, D, P, F>
fn clone(&self) -> ProxyDBService<S, D, P, F>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl<S, D, P, F> Debug for ProxyDBService<S, D, P, F>
impl<S, D, P, F> Debug for ProxyDBService<S, D, P, F>
§impl<S, D, P, F, State, Request> Service<State, Request> for ProxyDBService<S, D, P, F>where
S: Service<State, Request>,
<S as Service<State, Request>>::Error: Into<Box<dyn Error + Send + Sync>> + Send + Sync + 'static,
D: ProxyDB,
<D as ProxyDB>::Error: Into<Box<dyn Error + Send + Sync>> + Send + Sync + 'static,
P: ProxyQueryPredicate,
F: UsernameFormatter<State>,
State: Clone + Send + Sync + 'static,
Request: TryRefIntoTransportContext<State> + Send + 'static,
<Request as TryRefIntoTransportContext<State>>::Error: Into<Box<dyn Error + Send + Sync>> + Send + Sync + 'static,
impl<S, D, P, F, State, Request> Service<State, Request> for ProxyDBService<S, D, P, F>where
S: Service<State, Request>,
<S as Service<State, Request>>::Error: Into<Box<dyn Error + Send + Sync>> + Send + Sync + 'static,
D: ProxyDB,
<D as ProxyDB>::Error: Into<Box<dyn Error + Send + Sync>> + Send + Sync + 'static,
P: ProxyQueryPredicate,
F: UsernameFormatter<State>,
State: Clone + Send + Sync + 'static,
Request: TryRefIntoTransportContext<State> + Send + 'static,
<Request as TryRefIntoTransportContext<State>>::Error: Into<Box<dyn Error + Send + Sync>> + Send + Sync + 'static,
§type Response = <S as Service<State, Request>>::Response
type Response = <S as Service<State, Request>>::Response
§async fn serve(
&self,
ctx: Context<State>,
req: Request,
) -> Result<<ProxyDBService<S, D, P, F> as Service<State, Request>>::Response, <ProxyDBService<S, D, P, F> as Service<State, Request>>::Error>
async fn serve( &self, ctx: Context<State>, req: Request, ) -> Result<<ProxyDBService<S, D, P, F> as Service<State, Request>>::Response, <ProxyDBService<S, D, P, F> as Service<State, Request>>::Error>
§fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>
fn boxed(self) -> BoxService<S, Request, Self::Response, Self::Error>
Auto Trait Implementations§
impl<S, D, P, F> Freeze for ProxyDBService<S, D, P, F>
impl<S, D, P, F> RefUnwindSafe for ProxyDBService<S, D, P, F>
impl<S, D, P, F> Send for ProxyDBService<S, D, P, F>
impl<S, D, P, F> Sync for ProxyDBService<S, D, P, F>
impl<S, D, P, F> Unpin for ProxyDBService<S, D, P, F>
impl<S, D, P, F> UnwindSafe for ProxyDBService<S, D, P, F>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<S, State, Request, Connection> ConnectorService<State, Request> for S
impl<S, State, Request, Connection> ConnectorService<State, Request> for S
§type Connection = Connection
type Connection = Connection
ConnectorService
§type Error = <S as Service<State, Request>>::Error
type Error = <S as Service<State, Request>>::Error
§fn connect(
&self,
ctx: Context<State>,
req: Request,
) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<State, Request>>::Connection, State, Request>, <S as ConnectorService<State, Request>>::Error>> + Send
fn connect( &self, ctx: Context<State>, req: Request, ) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<State, Request>>::Connection, State, Request>, <S as ConnectorService<State, Request>>::Error>> + Send
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<State, S, Body> HttpClientExt<State> for S
impl<State, S, Body> HttpClientExt<State> for S
§type ExecuteResponse = Response<Body>
type ExecuteResponse = Response<Body>
execute
method.§type ExecuteError = <S as Service<State, Request<Body>>>::Error
type ExecuteError = <S as Service<State, Request<Body>>>::Error
execute
method.§fn get(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
fn get( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
GET
request to a URL. Read more§fn post(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
fn post( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
POST
request to a URL. Read more§fn put(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
fn put( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
PUT
request to a URL. Read more§fn patch(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
fn patch( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
PATCH
request to a URL. Read more§fn delete(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
fn delete( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
DELETE
request to a URL. Read more§fn head(
&self,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
fn head( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
HEAD
request to a URL. Read more§fn request(
&self,
method: Method,
url: impl IntoUrl,
) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
fn request( &self, method: Method, url: impl IntoUrl, ) -> RequestBuilder<'_, S, State, <S as HttpClientExt<State>>::ExecuteResponse>
§fn execute(
&self,
ctx: Context<State>,
request: Request<Body>,
) -> impl Future<Output = Result<<S as HttpClientExt<State>>::ExecuteResponse, <S as HttpClientExt<State>>::ExecuteError>>
fn execute( &self, ctx: Context<State>, request: Request<Body>, ) -> impl Future<Output = Result<<S as HttpClientExt<State>>::ExecuteResponse, <S as HttpClientExt<State>>::ExecuteError>>
Request
. Read more§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<S, P, B, E>(self, other: P) -> And<T, P>
fn and<S, P, B, E>(self, other: P) -> And<T, P>
Policy
that returns Action::Follow
only if self
and other
return
Action::Follow
. Read more§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.