Struct ProxyDBLayer

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

A Layer which wraps an inner Service to select a Proxy based on the given Context, and insert, if a Proxy is selected, it in the Context for further processing.

See the crate docs for examples and more info on the usage of this service.

Implementations

impl<D> ProxyDBLayer<D, bool, ()>

pub const fn new(db: D) -> ProxyDBLayer<D, bool, ()>

Create a new ProxyDBLayer with the given ProxyDB.

impl<D, P, F> ProxyDBLayer<D, P, F>

pub fn filter_mode(self, mode: ProxyFilterMode) -> ProxyDBLayer<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 preserve_proxy(self, preserve: bool) -> ProxyDBLayer<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, ) -> ProxyDBLayer<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, ) -> ProxyDBLayer<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.

Trait Implementations

impl<D, P, F> Clone for ProxyDBLayer<D, P, F>

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

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D, P, F> Debug for ProxyDBLayer<D, P, F>

where 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> Layer<S> for ProxyDBLayer<D, P, F>

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

type Service = ProxyDBService<S, D, P, F>

The service produced by the layer.

fn layer(&self, inner: S) -> <ProxyDBLayer<D, P, F> as Layer<S>>::Service

Wrap the given service with the middleware, returning a new service.

fn into_layer(self, inner: S) -> <ProxyDBLayer<D, P, F> as Layer<S>>::Service

Same as layer but consuming self after the service was created.