Struct tor_socksproto::SocksProxyHandshake

pub struct SocksProxyHandshake { /* private fields */ }

Available on crate feature proxy-handshake only.

The Proxy (responder) side of an ongoing SOCKS handshake.

To perform a handshake, call the SocksProxyHandshake::handshake method repeatedly with new inputs, until the resulting Action has finished set to true.

Implementations

impl SocksProxyHandshake

pub fn new() -> Self

Construct a new SocksProxyHandshake in its initial state

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

Try to advance a SocksProxyHandshake, given some client 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 client, and how much of its input to consume.

pub fn finished(&self) -> bool

Return true if this handshake is finished.

pub fn into_request(self) -> Option<SocksRequest>

Consume this handshake’s state; if it finished successfully, return a SocksRequest.

Trait Implementations

impl Clone for SocksProxyHandshake

fn clone(&self) -> SocksProxyHandshake

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SocksProxyHandshake

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

Formats the value using the given formatter.

impl Default for SocksProxyHandshake

fn default() -> Self

Returns the “default value” for a type.