Skip to main content

ProxyDBService

Struct ProxyDBService

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

Available on crate feature proxy only.

Expand description

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) -> 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 maybe_with_max_proxies( self, max_proxies: Option<NonZero<usize>>, ) -> ProxyDBService<S, D, P, F>

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<NonZero<usize>>, ) -> &mut ProxyDBService<S, D, P, F>

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: NonZero<usize>, ) -> ProxyDBService<S, D, P, F>

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: NonZero<usize>, ) -> &mut ProxyDBService<S, D, P, F>

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) -> ProxyDBService<S, D, P, F>

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

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, ) -> 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 fn with_single_proxy(self, single_proxy: bool) -> ProxyDBService<S, D, P, F>

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

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, ) -> ProxyDBService<S, D, P, F>

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

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, 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. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

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. Read more

impl<S, D, P, F, Input> Service<Input> for ProxyDBService<S, D, P, F>
where S: Service<Input>, <S as Service<Input>>::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, 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<<ProxyDBService<S, D, P, F> as Service<Input>>::Output, <ProxyDBService<S, D, P, F> as Service<Input>>::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.

Auto Trait Implementations§

impl<S, D, P, F> Freeze for ProxyDBService<S, D, P, F>
where S: Freeze, D: Freeze, P: Freeze, F: Freeze,

impl<S, D, P, F> RefUnwindSafe for ProxyDBService<S, D, P, F>
where S: RefUnwindSafe, D: RefUnwindSafe, P: RefUnwindSafe, F: RefUnwindSafe,

impl<S, D, P, F> Send for ProxyDBService<S, D, P, F>
where S: Send, D: Send, P: Send, F: Send,

impl<S, D, P, F> Sync for ProxyDBService<S, D, P, F>
where S: Sync, D: Sync, P: Sync, F: Sync,

impl<S, D, P, F> Unpin for ProxyDBService<S, D, P, F>
where S: Unpin, D: Unpin, P: Unpin, F: Unpin,

impl<S, D, P, F> UnsafeUnpin for ProxyDBService<S, D, P, F>
where S: UnsafeUnpin, D: UnsafeUnpin, P: UnsafeUnpin, F: UnsafeUnpin,

impl<S, D, P, F> UnwindSafe for ProxyDBService<S, D, P, F>
where S: UnwindSafe, D: UnwindSafe, P: UnwindSafe, F: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<S, Input, Connection> ConnectorService<Input> for S
where S: Service<Input, Output = EstablishedClientConnection<Connection, Input>>, <S as Service<Input>>::Error: Into<ConnectionError>, Connection: Send + ExtensionsRef,

type Connection = Connection

Connection returned by the ConnectorService

fn connect( &self, input: Input, ) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<Input>>::Connection, Input>, ConnectionError>> + Send

Establish a connection, which often involves some kind of handshake, or connection revival. 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, ReqBody, ResBody> GrpcService<ReqBody> for T
where T: Service<Request<ReqBody>, Output = Response<ResBody>>, <T as Service<Request<ReqBody>>>::Error: Into<Box<dyn Error + Sync + Send>>, ResBody: Body, <ResBody as Body>::Error: Into<Box<dyn Error + Sync + Send>>,

type ResponseBody = ResBody

Responses body given by the service.

type Error = <T as Service<Request<ReqBody>>>::Error

Errors produced by the service.

fn serve( &self, request: Request<ReqBody>, ) -> impl Future<Output = Result<Response<<T as GrpcService<ReqBody>>::ResponseBody>, <T as GrpcService<ReqBody>>::Error>> + Send

Process the request and return the response asynchronously. Read more

impl<S, Body> HttpClientExt for S
where S: Service<Request, Output = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

type ExecuteResponse = Response<Body>

The response type returned by the execute method.

type ExecuteError = <S as Service<Request>>::Error

The error type returned by the execute method.

fn get( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a GET request to a URL. Read more

fn post( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a POST request to a URL. Read more

fn put( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a PUT request to a URL. Read more

fn patch( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a PATCH request to a URL. Read more

fn delete( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a DELETE request to a URL. Read more

fn head( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a HEAD request to a URL. Read more

fn connect( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a CONNECT request to a URL. Read more

fn request( &self, method: Method, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Start building a Request with the Method and Url. Read more

fn build_from_request<RequestBody>( &self, request: Request<RequestBody>, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
where RequestBody: Into<Body>,

Start building a Request, using the given Request. Read more

fn execute( &self, request: Request, ) -> impl Future<Output = Result<<S as HttpClientExt>::ExecuteResponse, <S as HttpClientExt>::ExecuteError>>

Executes a Request. Read more

impl<S, Body> HttpClientWebSocketExt<Body> for S
where S: Service<Request, Output = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

fn websocket( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

Create a new WebSocketRequestBuilder] to be used to establish a WebSocket connection over http/1.1.

fn websocket_h2( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

Create a new WebSocketRequestBuilder to be used to establish a WebSocket connection over h2.

fn websocket_with_request<RequestBody>( &self, req: Request<RequestBody>, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
where RequestBody: Into<Body>,

Create a new WebSocketRequestBuilder starting from the given request. 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<S> IntoEndpointService<(S,)> for S
where S: Service<Request>,

type Service = S

fn into_endpoint_service(self) -> <S as IntoEndpointService<(S,)>>::Service

convert the type into a rama_core::Service.

impl<S, State> IntoEndpointServiceWithState<(S,), State> for S
where S: Service<Request>,

type Service = S

fn into_endpoint_service_with_state( self, _state: State, ) -> <S as IntoEndpointServiceWithState<(S,), State>>::Service

convert the type into a rama_core::Service with state.

impl<T> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

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: Sized + 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: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer

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