Struct ProxyDBService 

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

A Service which resolves proxy candidates from the given input Extensions.

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.

By default up to DEFAULT_PROXY_DB_MAX_PROXIES matches are published as ProxyRoutes. Each route carries its corresponding Proxy and proxy ID as route-specific extensions, so only the successful connection attempt inherits them. Legacy single-proxy mode inserts one singular ProxyRoute and publishes its proxy metadata after the inner service succeeds.

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

Create a new ProxyDBService with the given inner Service and ProxyDB.

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

pub fn maybe_with_max_proxies(self, max_proxies: Option<NonZeroUsize>) -> Self

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

pub fn maybe_set_max_proxies( &mut self, max_proxies: Option<NonZeroUsize>, ) -> &mut Self

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

pub fn with_max_proxies(self, max_proxies: NonZeroUsize) -> Self

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

pub fn set_max_proxies(&mut self, max_proxies: NonZeroUsize) -> &mut Self

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

pub fn without_max_proxies(self) -> Self

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

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

Limit the number of proxy candidates published for one query.

The default is DEFAULT_PROXY_DB_MAX_PROXIES. Use Self::without_max_proxies for an unbounded query.

pub fn with_filter_mode(self, mode: ProxyFilterMode) -> Self

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 Self

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 with_single_proxy(self, single_proxy: bool) -> Self

Select and insert only one proxy instead of publishing every match as an ordered route plan. This uses the database’s singular-selection semantics, preserves legacy pre-fallback behaviour, and is disabled by default.

pub fn set_single_proxy(&mut self, single_proxy: bool) -> &mut Self

Select and insert only one proxy instead of publishing every match as an ordered route plan. This uses the database’s singular-selection semantics, preserves legacy pre-fallback behaviour, and is disabled by default.

pub fn with_overwrite_proxy(self, overwrite_proxy: bool) -> Self

Overwrite an existing singular ProxyRoute with the selected proxy route or route plan. This is disabled by default in both plural and singular selection modes.

pub fn set_overwrite_proxy(&mut self, overwrite_proxy: bool) -> &mut Self

Overwrite an existing singular ProxyRoute with the selected proxy route or route plan. This is disabled by default in both plural and singular selection modes.

pub fn with_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 with_username_formatter<Formatter>( self, f: Formatter, ) -> ProxyDBService<S, D, P, Formatter>

Set an optional UsernameFormatter for Basic-auth proxy usernames. It is called separately for each published candidate, so routing labels can depend on that proxy’s metadata. Bearer credentials and proxies without credentials are left unchanged.

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: Clone, D: Clone, P: Clone, F: Clone> Clone for ProxyDBService<S, D, P, F>

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: Debug, D: Debug, P: Debug, F: Debug> Debug for ProxyDBService<S, D, P, F>

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

Formats the value using the given formatter.

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

where S: Service<Input, Error: Into<BoxError> + Send + Sync + 'static>, D: ProxyDB<Error: Into<BoxError> + Send + Sync + 'static>, P: ProxyQueryPredicate, F: UsernameFormatter, Input: TransportProtocolInputExt + ExtensionsRef + Send + 'static,

type Output = <S as Service<Input>>::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, input: Input) -> Result<Self::Output, Self::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.