Struct tokio_socks::tcp::Socks5Stream

pub struct Socks5Stream<S> { /* fields omitted */ }

A SOCKS5 client.

For convenience, it can be dereferenced to it's inner socket.

Implementations

impl Socks5Stream<TcpStream>

pub async fn connect<'t, P, T>(
    proxy: P,
    target: T
) -> Result<Socks5Stream<TcpStream>> where
    P: ToProxyAddrs,
    T: IntoTargetAddr<'t>, 

Connects to a target server through a SOCKS5 proxy given the proxy address.

Error

It propagates the error that occurs in the conversion from T to TargetAddr.

pub async fn connect_with_password<'a, 't, P, T>(
    proxy: P,
    target: T,
    username: &'a str,
    password: &'a str
) -> Result<Socks5Stream<TcpStream>> where
    P: ToProxyAddrs,
    T: IntoTargetAddr<'t>, 

Connects to a target server through a SOCKS5 proxy using given username, password and the address of the proxy.

Error

It propagates the error that occurs in the conversion from T to TargetAddr.

impl<S> Socks5Stream<S> where
    S: AsyncRead + AsyncWrite + Unpin, 

pub async fn connect_with_socket<'t, T>(
    socket: S,
    target: T
) -> Result<Socks5Stream<S>> where
    T: IntoTargetAddr<'t>, 

Connects to a target server through a SOCKS5 proxy given a socket to it.

Error

It propagates the error that occurs in the conversion from T to TargetAddr.

pub async fn connect_with_password_and_socket<'a, 't, T>(
    socket: S,
    target: T,
    username: &'a str,
    password: &'a str
) -> Result<Socks5Stream<S>> where
    T: IntoTargetAddr<'t>, 

Connects to a target server through a SOCKS5 proxy using given username, password and a socket to the proxy

Error

It propagates the error that occurs in the conversion from T to TargetAddr.

pub fn into_inner(self) -> S

Consumes the Socks5Stream, returning the inner socket.

pub fn target_addr(&self) -> TargetAddr

Returns the target address that the proxy server connects to.

Trait Implementations

impl<T> AsyncRead for Socks5Stream<T> where
    T: AsyncRead + Unpin, 

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(
    self: Pin<&mut Self>,
    cx: &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize>>

Attempts to read from the AsyncRead into buf.

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<T> AsyncWrite for Socks5Stream<T> where
    T: AsyncWrite + Unpin, 

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

Attempt to write bytes from buf into the object.

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

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<()>>

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<S: Debug> Debug for Socks5Stream<S>

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

Formats the value using the given formatter.

impl<S> Deref for Socks5Stream<S>

type Target = S

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<S> DerefMut for Socks5Stream<S>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.