Struct Connector

pub struct Connector<C, S> { /* private fields */ }

Proxy Forward Socks5Connector implementation, which actually is able to accept connect requests and process them.

The Default implementation establishes a connection for the requested destination Authority and pipes the incoming Stream with the established outgoing Stream by copying the bytes without doing anyting else with them.

You can customise the Connector fully by creating it using Connector::new or overwrite any of the default components using either or both of Connector::with_connector and Connector::with_service.

Lazy Connectors

Please use LazyConnector in case you do not want the connctor to establish a connection yet and instead only want to do so once you have the first request, which can be useful for things such as MITM socks5 proxies for http(s) traffic.

Implementations

impl<C, S> Connector<C, S>

pub fn new(connector: C, service: S) -> Connector<C, S>

Create a new Connector.

In case you only wish to overwrite one of these components you can also use a Default Connector and overwrite the specific component using Connector::with_connector or Connector::with_service.

pub fn set_hide_local_address(&mut self, hide: bool) -> &mut Connector<C, S>

Define whether or not the local address is exposed as the bind address in the reply, by default it is exposed.

pub fn with_hide_local_address(self, hide: bool) -> Connector<C, S>

Define whether or not the local address is exposed as the bind address in the reply, by default it is exposed.

pub fn set_connect_timeout( &mut self, connect_timeout: Duration, ) -> &mut Connector<C, S>

Set field with Some(value)

pub fn with_connect_timeout(self, connect_timeout: Duration) -> Connector<C, S>

Replace field with Some(value)

pub fn maybe_with_connect_timeout( self, connect_timeout: Option<Duration>, ) -> Connector<C, S>

Replace field with the provided option

impl<C, S> Connector<C, S>

pub fn with_connector<T>(self, connector: T) -> Connector<T, S>

Overwrite the Connector’s connector Service used to establish a Tcp connection used as the Stream in the direction from target to source.

Any Service can be used as long as it has the signature:

(Context, TcpRequest)
    -> (EstablishedConnection<T, TcpRequest>, Into<BoxError>)

pub fn with_service<T>(self, service: T) -> Connector<C, T>

Overwrite the Connector’s Service used to actually do the proxy between the source and target Stream.

Any Service can be used as long as it has the signature:

(Context, ProxyRequest) -> ((), Into<BoxError>)

Trait Implementations

impl<C, S> Clone for Connector<C, S>

where C: Clone, S: Clone,

fn clone(&self) -> Connector<C, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C, S> Debug for Connector<C, S>

where C: Debug, S: Debug,

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

Formats the value using the given formatter.

impl Default for Connector<TcpConnector, StreamForwardService>

fn default() -> Connector<TcpConnector, StreamForwardService>

Returns the “default value” for a type.