Struct Socks5Client

pub struct Socks5Client { /* private fields */ }

Socks5 client implementation of RFC 1928

Implementations

impl Client

pub fn new() -> Client

Creates a new socks5 Client.

pub fn with_auth(self, auth: impl Into<Socks5Auth>) -> Client

Set the Socks5Auth to be used by this client.

pub fn set_auth(&mut self, auth: impl Into<Socks5Auth>) -> &mut Client

Set the Socks5Auth to be used by this client.

impl Client

pub async fn handshake_connect<S>( &self, stream: &mut S, destination: &Authority, ) -> Result<Authority, HandshakeError>

where S: Stream + Unpin,

Establish a connection with a Socks5 server making use of the Command::Connect flow.

In case the handshake was sucessfull it will return the local address used by the Socks5 (proxy) server to connect to the destination Authority on behalf of this Client.

pub async fn handshake_bind<S>( &self, stream: S, requested_bind_address: Option<SocketAddress>, ) -> Result<Binder<S>, HandshakeError>

where S: Stream + Unpin,

Establish a connection with a Socks5 server making use of the Command::Bind flow.

Usually you do not request a bind address yourself, but for some special-purpose or local setups it might be desired that the client requests a specific bind interface to the server.

Note that the server is free to ignore this request, even when requested. You can use Binder::selected_bind_address to compare it with Binder::requested_bind_address in case your special purpose use-case requires the client’s bind address choice to be respected.

This method returns a Binder that contains the address to which the target server is to connect to the socks5 server on behalf of the client (callee of this call). The Binder takes ownership over of the input Stream such that it can await the established connection from target server to socks5 server.

pub async fn handshake_udp<S>( &self, stream: S, ) -> Result<UdpSocketRelayBinder<S>, HandshakeError>

where S: Stream + Unpin,

Establish a connection with a Socks5 server making use of the Command::UdpAssociate flow.

This method returns a UdpSocketRelayBinder that can be used to bind to an interface as to get a [UdpSocketRelay] ready to to send udp packets through socks5 proxy server to the required.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Default for Client

fn default() -> Client

Returns the “default value” for a type.