Struct ProxyDBService

pub struct ProxyDBService<S, D, P, F> { /* private fields */ }

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

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>

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>

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>

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>

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>

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>

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 get_ref(&self) -> &S

Gets a reference to the underlying service.

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>

where S: Clone, D: Clone, P: Clone, F: Clone,

fn clone(&self) -> ProxyDBService<S, D, P, F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S, D, P, F> Debug for ProxyDBService<S, D, P, F>

where S: Debug, D: Debug, P: Debug, F: Debug,

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

Formats the value using the given formatter.

impl<S, D, P, F, Request> Service<Request> for ProxyDBService<S, D, P, F>

where S: Service<Request>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>> + Send + Sync + 'static, D: ProxyDB, <D as ProxyDB>::Error: Into<Box<dyn Error + Sync + Send>> + Send + Sync + 'static, P: ProxyQueryPredicate, F: UsernameFormatter, Request: TryRefIntoTransportContext + Send + 'static, <Request as TryRefIntoTransportContext>::Error: Into<Box<dyn Error + Sync + Send>> + Send + 'static,

type Response = <S as Service<Request>>::Response

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, req: Request, ) -> Result<<ProxyDBService<S, D, P, F> as Service<Request>>::Response, <ProxyDBService<S, D, P, F> as Service<Request>>::Error>

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

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

Box this service to allow for dynamic dispatch.