Struct Binder

pub struct Binder<A, S> { /* private fields */ }

Only “useful” public Socks5Binder implementation, which actually is able to accept bind requests and process them.

The Default implementation opens a new socket for accepting 1 incoming connection. Once received it will pipe the original request (source) stream together with the received inbound stream from the secondary callee.

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

Implementations

impl<A, S> Binder<A, S>

pub fn new(acceptor: A, service: S) -> Binder<A, S>

Create a new Binder.

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

impl<A, S> Binder<A, S>

pub fn with_acceptor<T>(self, acceptor: T) -> Binder<T, S>

Overwrite the Binder’s [AcceptorFactory], used to open a listener, return the address and wait for an incoming connection which it will return.

pub fn with_service<T>(self, service: T) -> Binder<A, T>

Overwrite the Binder’s Service used to actually do the proxy between the source and incoming bind Stream.

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

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

pub fn set_bind_interface( &mut self, interface: impl Into<Interface>, ) -> &mut Binder<A, S>

Define the (network) Interface to bind to.

By default it will use the client’s requested bind address, which is in many cases not what you want.

pub fn set_default_bind_interface(&mut self) -> &mut Binder<A, S>

Define the default (network) Interface to bind to (0.0.0.0:0).

By default it will use the client’s requested bind address, which is in many cases not what you want.

pub fn with_bind_interface( self, interface: impl Into<Interface>, ) -> Binder<A, S>

Define the (network) Interface to bind to.

By default it will use the client’s requested bind address, which is in many cases not what you want.

pub fn with_default_bind_interface(self) -> Binder<A, S>

Define the default (network) Interface to bind to (0.0.0.0:0).

By default it will use the client’s requested bind address, which is in many cases not what you want.

pub fn set_accept_timeout( &mut self, accept_timeout: Duration, ) -> &mut Binder<A, S>

Set field with Some(value)

pub fn with_accept_timeout(self, accept_timeout: Duration) -> Binder<A, S>

Replace field with Some(value)

pub fn maybe_with_accept_timeout( self, accept_timeout: Option<Duration>, ) -> Binder<A, S>

Replace field with the provided option

Trait Implementations

impl<A, S> Clone for Binder<A, S>

where A: Clone, S: Clone,

fn clone(&self) -> Binder<A, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A, S> Debug for Binder<A, S>

where A: Debug, S: Debug,

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

Formats the value using the given formatter.

impl Default for Binder<Timeout<DefaultAcceptorFactory, LayerErrorStatic<Elapsed>>, StreamForwardService>

fn default() -> Binder<Timeout<DefaultAcceptorFactory, LayerErrorStatic<Elapsed>>, StreamForwardService>

Returns the “default value” for a type.

impl<S, F, StreamService> Socks5BinderSeal<S> for Binder<F, StreamService>

where S: Stream + Unpin, F: SocketService, <F as SocketService>::Socket: Acceptor, <<F as SocketService>::Socket as Acceptor>::Stream: Unpin, StreamService: Service<ProxyRequest<S, <<F as SocketService>::Socket as Acceptor>::Stream>, Response = ()>, <StreamService as Service<ProxyRequest<S, <<F as SocketService>::Socket as Acceptor>::Stream>>>::Error: Into<Box<dyn Error + Sync + Send>>,

async fn accept_bind( &self, ctx: Context, stream: S, requested_bind_address: Authority, ) -> Result<(), Error>