Struct tor_socksproto::SocksClientHandshake

pub struct SocksClientHandshake { /* private fields */ }

Available on crate feature client-handshake only.

The client (initiator) side of a SOCKS handshake.

Implementations

impl SocksClientHandshake

pub fn new(request: SocksRequest) -> Self

Construct a new SocksClientHandshake that will attempt to negotiate with a peer using request.

pub fn into_reply(self) -> Option<SocksReply>

Consume this handshake’s state; if it finished successfully, return the SocksReply that we got from the proxy..

pub fn handshake(&mut self, input: &[u8]) -> TResult<Action>

Try to advance a SocksProxyHandshake, given some proxy input in input.

If there isn’t enough input, gives a Truncated. In this case, the caller must retain the input, and pass it to a later invocation of handshake. Input should only be regarded as consumed when the Action::drain field is nonzero.

Other errors (besides Truncated) indicate a failure.

On success, return an Action describing what to tell the proxy, and how much of its input to consume.

Trait Implementations

impl Clone for SocksClientHandshake

fn clone(&self) -> SocksClientHandshake

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SocksClientHandshake

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

Formats the value using the given formatter.