Struct fast_socks5::client::Socks5Stream

pub struct Socks5Stream<S: AsyncRead + AsyncWrite + Unpin> { /* fields omitted */ }

A SOCKS5 client. Socks5Stream implements AsyncRead and AsyncWrite.

Methods

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

pub async fn use_stream(
    socket: S,
    target_addr: TargetAddr,
    auth: Option<AuthenticationMethod>,
    config: Config
) -> Result<Self>

Possibility to use a stream already created rather than creating a whole new TcpStream::connect().

impl Socks5Stream<TcpStream>

Api if you want to use TcpStream to create a new connection to the SOCKS5 server.

pub async fn connect<T>(
    socks_server: T,
    target_addr: String,
    target_port: u16,
    config: Config
) -> Result<Self> where
    T: ToSocketAddrs, 

Connects to a target server through a SOCKS5 proxy.

pub async fn connect_with_password<T>(
    socks_server: T,
    target_addr: String,
    target_port: u16,
    username: String,
    password: String,
    config: Config
) -> Result<Self> where
    T: ToSocketAddrs, 

Connect with credentials

Trait Implementations

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

Allow us to read directly from the struct

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

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

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

Allow us to write directly into the struct

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

Attempt to write bytes from buf into the object.

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

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

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

Attempt to close the object.

fn poll_write_vectored(
    self: Pin<&mut Self>,
    cx: &mut Context,
    bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

impl<S: Debug + AsyncRead + AsyncWrite + Unpin> Debug for Socks5Stream<S>

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

Formats the value using the given formatter.