Struct async_proxy::clients::socks4::general::Socks4General

pub struct Socks4General { /* fields omitted */ }

The actual type that represents the Socks4 proxy client. Contains a tcp stream that operates on

Trait Implementations

impl AsyncRead for Socks4General

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize>>

Attempts to read from the AsyncRead into buf.

unsafe fn prepare_uninitialized_buffer(
    &self,
    buf: &mut [MaybeUninit<u8>]
) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

fn poll_read_buf<B>(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut B
) -> Poll<Result<usize, Error>> where
    B: BufMut, 

Pulls some bytes from this source into the specified BufMut, returning how many bytes were read.

impl AsyncWrite for Socks4General

fn poll_write(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Error>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_buf<B>(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut B
) -> Poll<Result<usize, Error>> where
    B: Buf, 

Writes a Buf into this value, returning how many bytes were written.

impl ProxyStream for Socks4General

type Stream = TcpStream

Represents a stream that the proxy client operates on (sends protocol data over it)

type ErrorKind = ErrorKind

Used for internal proxy error indication

type ConnParams = ConnParams

Parameters that are passed to the connect function.

fn connect<'async_trait>(
    stream: Self::Stream,
    params: Self::ConnParams
) -> Pin<Box<dyn Future<Output = Result<Self, Self::ErrorKind>> + Send + 'async_trait>> where
    Self: 'async_trait, 

Takes ownership of an existant stream and establishes on it connection. Returns a ProxyStream if the connection was successful, an error if not.