Struct ProxyRoutesConnector 

#[non_exhaustive]
pub struct ProxyRoutesConnector<S> { /* private fields */ }

Available on crate feature net only.

Try ordered proxy routes until a connection is established.

Every route receives an isolated Fork of the original input with the selected ProxyRoute inserted into its extensions. A transport-domain failure advances to the next route only when its kind indicates that another route can plausibly help. Authentication, invalid-input and internal failures stop fallback even when reported by the transport domain. Application, local and unclassified failures also stop immediately because another transport route should not normally change their outcome. If multiple attempted routes fail, their contextualized errors are retained in a ProxyRouteConnectError.

By default an existing singular ProxyRoute is honored before a ProxyRoutes extension, or ProxyRoute::Direct is used when neither is present. Self::with_routes configures a route collection that takes precedence over a collection on the input. The default precedence order is: singular ProxyRoute, configured routes, input routes, implicit direct. Self::with_overwrite or ProxyRoutes::with_overwrite explicitly lets the selected route collection take precedence over a singular route.

Implementations

impl<S> ProxyRoutesConnector<S>

pub const fn new(inner: S) -> ProxyRoutesConnector<S>

Create a connector that reads routes from the input extensions.

pub fn with_routes( inner: S, routes: impl Into<ProxyRoutes>, ) -> ProxyRoutesConnector<S>

Create a connector that uses the given ordered routes unless the input already contains a singular selected route.

pub const fn with_overwrite(self, overwrite: bool) -> ProxyRoutesConnector<S>

Let the selected route collection take precedence over an existing singular ProxyRoute.

Overwriting is disabled by default. A ProxyRoutes extension can independently opt in through ProxyRoutes::with_overwrite.

pub fn with_timeout(self, timeout: Duration) -> ProxyRoutesConnector<S>

Limit the complete ordered-route operation to timeout.

This is distinct from a timeout applied to the inner connector: an inner timeout applies to one route and can advance to the next route, while this budget covers every route and stops the operation when it is exhausted. Failures completed before the budget expired remain available through ProxyRouteConnectError.

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 for ProxyRoutesConnector<S>

where S: Clone,

fn clone(&self) -> ProxyRoutesConnector<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Debug for ProxyRoutesConnector<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S, Input> Service<Input> for ProxyRoutesConnector<S>

where S: ConnectorService<Input>, Input: Fork + ExtensionsRef + Send + 'static,

type Output = EstablishedClientConnection<<S as ConnectorService<Input>>::Connection, Input>

The type of the output returned by the service.

type Error = ConnectionError

The type of error returned by the service.

async fn serve( &self, input: Input, ) -> Result<<ProxyRoutesConnector<S> as Service<Input>>::Output, <ProxyRoutesConnector<S> 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.