Struct Request

pub struct Request {
    pub version: ProtocolVersion,
    pub command: Command,
    pub destination: Authority,
}

The SOCKS request sent by the client.

Once the method-dependent subnegotiation has completed, the client sends the request details. If the negotiated method includes encapsulation for purposes of integrity checking and/or confidentiality, these requests MUST be encapsulated in the method- dependent encapsulation.

The SOCKS request is formed as follows:

+----+-----+-------+------+----------+----------+
|VER | CMD |  RSV  | ATYP | DST.ADDR | DST.PORT |
+----+-----+-------+------+----------+----------+
| 1  |  1  | X'00' |  1   | Variable |    2     |
+----+-----+-------+------+----------+----------+

The SOCKS server will typically evaluate the request based on source and destination addresses, and return one or more reply messages, as appropriate for the request type.

Fields

version: ProtocolVersion

command: Command

destination: Authority

Implementations

impl Request

pub async fn read_from<R>(r: &mut R) -> Result<Request, ProtocolError>

where R: AsyncRead + Unpin,

Read the client Request, decoded from binary format as specified by RFC 1928 from the reader.

pub async fn write_to<W>(&self, w: &mut W) -> Result<(), Error>

where W: AsyncWrite + Unpin,

Write the client Request in binary format as specified by RFC 1928 into the writer.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl PartialEq<Request> for RequestRef<'_>

fn eq(&self, other: &Request) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<RequestRef<'_>> for Request

fn eq(&self, other: &RequestRef<'_>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Request

fn eq(&self, other: &Request) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Request

impl StructuralPartialEq for Request