Struct Connector 

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

Available on crate feature socks5 only.

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 HostWithPort and pipes the incoming Io with the established outgoing Io by copying the bytes without doing anything 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

Use LazyConnector only when application bytes are required before the egress target can be selected. MITM proxies with a target from the SOCKS5 handshake should normally use this connector and inspect the resulting BridgeIo with Rama’s Relay/Peek services.

Connection policy belongs in the connector stack. Wrap a custom connector in TimeoutLayer when its connection attempts should be bounded.

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 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_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.

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 the egress Io in the direction from target to source.

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

(ConnectRequest)
    -> (EstablishedConnection<T, ConnectRequest>, Into<BoxError>)

Replacing a DefaultConnector’s connector removes its default connect timeout. Wrap the new connector in TimeoutLayer when its connection attempts should be bounded.

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 Io.

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

(BridgeIo) -> ((), Into<BoxError>)

impl Connector<Timeout<DnsConnector<TcpConnector>, LayerErrorStatic<Elapsed>>, IoForwardService>

pub fn default_with_exec( exec: Executor, ) -> Connector<Timeout<DnsConnector<TcpConnector>, LayerErrorStatic<Elapsed>>, IoForwardService>

Create a DefaultConnector whose forward bridge observes graceful shutdown via the given Executor.

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<Timeout<DnsConnector<TcpConnector>, LayerErrorStatic<Elapsed>>, IoForwardService>

fn default() -> Connector<Timeout<DnsConnector<TcpConnector>, LayerErrorStatic<Elapsed>>, IoForwardService>

Returns the “default value” for a type.