Enum bolt_client::Stream

pub enum Stream {
    Tcp(TcpStream),
    SecureTcp(Box<TlsStream<TcpStream>>),
}

This is supported on crate feature tokio-stream only.

A convenient wrapper around a TcpStream or a TlsStream.

Variants

Tcp(TcpStream)

SecureTcp(Box<TlsStream<TcpStream>>)

Implementations

impl Stream

pub async fn connect(
    addr: impl ToSocketAddrs,
    domain: Option<impl AsRef<str>>
) -> Result<Self>

Establish a connection with a remote socket. If a domain is provided, TLS negotiation will be attempted.

Trait Implementations

impl AsyncRead for Stream

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut ReadBuf<'_>
) -> Poll<Result<()>>

Attempts to read from the AsyncRead into buf.

impl AsyncWrite for Stream

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.

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

Like poll_write, except that it writes from a slice of buffers.

pub fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl Debug for Stream

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

Formats the value using the given formatter.

impl<'pin> Unpin for Stream where
    __Stream<'pin>: Unpin,