Struct Associate 

pub struct Associate<S> { /* private fields */ }

Socks5 command type Associate

Reply the client with Associate::reply() to complete the command negotiation.

Implementations

impl Associate<NeedReply>

pub async fn reply( self, reply: Reply, addr: Address, ) -> Result<Associate<Ready>, (Error, TcpStream)>

Reply to the SOCKS5 client with the given reply and address.

If encountered an error while writing the reply, the error alongside the original TcpStream is returned.

impl Associate<Ready>

pub async fn wait_close(&mut self) -> Result<(), Error>

Wait until the SOCKS5 client closes this TCP connection.

Socks5 protocol defines that when the client closes the TCP connection used to send the associate command, the server should release the associated UDP socket.

impl<S> Associate<S>

pub async fn close(&mut self) -> Result<(), Error>

Causes the other peer to receive a read of length 0, indicating that no more data will be sent. This only closes the stream in one direction.

pub fn local_addr(&self) -> Result<SocketAddr, Error>

Returns the local address that this stream is bound to.

pub fn peer_addr(&self) -> Result<SocketAddr, Error>

Returns the remote address that this stream is connected to.

pub fn get_ref(&self) -> &TcpStream

Returns a shared reference to the underlying stream.

Note that this may break the encapsulation of the SOCKS5 connection and you should not use this method unless you know what you are doing.

pub fn get_mut(&mut self) -> &mut TcpStream

Returns a mutable reference to the underlying stream.

Note that this may break the encapsulation of the SOCKS5 connection and you should not use this method unless you know what you are doing.

pub fn into_inner(self) -> TcpStream

Consumes the Associate<S> and returns the underlying TcpStream.

Trait Implementations

impl<S: Debug> Debug for Associate<S>

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

Formats the value using the given formatter.