Struct Header 

pub struct Header {
    pub version: ProtocolVersion,
    pub methods: SmallVec<[SocksMethod; 2]>,
}

The client connects to the server, and sends a header which contains the protocol version desired and SOCKS methods supported by the client.

+-----+----------+----------+
| VER | NMETHODS | METHODS  |
+-----+----------+----------+
|  1  |    1     | 1 to 255 |
+-----+----------+----------|

Reference: https://datatracker.ietf.org/doc/html/rfc1928

Fields

version: ProtocolVersion

methods: SmallVec<[SocksMethod; 2]>

Implementations

impl Header

pub fn new(methods: impl Into<SmallVec<[SocksMethod; 2]>>) -> Header

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

where R: AsyncRead + Unpin,

Read the client Header, 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 Header in binary format as specified by RFC 1928 into the writer.

pub fn write_to_buf<B>(&self, buf: &mut B)

where B: BufMut,

Write the client Header in binary format as specified by RFC 1928 into the buffer.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl PartialEq for Header

fn eq(&self, other: &Header) -> 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 Header

impl StructuralPartialEq for Header