Struct Tunnel

pub struct Tunnel<C> { /* private fields */ }

Available on crate features client and client-legacy only.

Tunnel Proxy via HTTP CONNECT

This is a connector that can be used by the legacy::Client. It wraps another connector, and after getting an underlying connection, it creates an HTTP CONNECT tunnel over it.

Implementations

impl<C> Tunnel<C>

pub fn new(proxy_dst: Uri, connector: C) -> Self

Create a new Tunnel service.

This wraps an underlying connector, and stores the address of a tunneling proxy server.

A Tunnel can then be called with any destination. The dst passed to call will not be used to create the underlying connection, but will be used in an HTTP CONNECT request sent to the proxy destination.

pub fn with_auth(self, auth: HeaderValue) -> Self

Add proxy-authorization header value to the CONNECT request.

pub fn with_headers(self, headers: HeaderMap) -> Self

Add extra headers to be sent with the CONNECT request.

If existing headers have been set, these will be merged.

Trait Implementations

impl<C: Clone> Clone for Tunnel<C>

fn clone(&self) -> Tunnel<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for Tunnel<C>

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

Formats the value using the given formatter.

impl<C> Service<Uri> for Tunnel<C>

where C: Service<Uri>, C::Future: Send + 'static, C::Response: Read + Write + Unpin + Send + 'static, C::Error: Into<Box<dyn StdError + Send + Sync>>,

type Response = <C as Service<Uri>>::Response

Responses given by the service.

type Error = TunnelError

Errors produced by the service.

type Future = Tunneling<<C as Service<Uri>>::Future, <C as Service<Uri>>::Response>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.

fn call(&mut self, dst: Uri) -> Self::Future

Process the request and return the response asynchronously.