Struct tokio_util::io::SyncIoBridge

pub struct SyncIoBridge<T> { /* private fields */ }

Available on crate feature io only.

Use a tokio::io::AsyncRead synchronously as a std::io::Read or a tokio::io::AsyncWrite as a std::io::Write.

Implementations

impl<T: AsyncWrite> SyncIoBridge<T>

pub fn is_write_vectored(&self) -> bool

Available on crate feature io-util only.

Determines if the underlying tokio::io::AsyncWrite target supports efficient vectored writes.

See tokio::io::AsyncWrite::is_write_vectored.

impl<T: Unpin> SyncIoBridge<T>

pub fn new(src: T) -> Self

Available on crate feature io-util only.

Use a tokio::io::AsyncRead synchronously as a std::io::Read or a tokio::io::AsyncWrite as a std::io::Write.

When this struct is created, it captures a handle to the current thread’s runtime with tokio::runtime::Handle::current. It is hence OK to move this struct into a separate thread outside the runtime, as created by e.g. tokio::task::spawn_blocking.

Stated even more strongly: to make use of this bridge, you must move it into a separate thread outside the runtime. The synchronous I/O will use the underlying handle to block on the backing asynchronous source, via tokio::runtime::Handle::block_on. As noted in the documentation for that function, an attempt to block_on from an asynchronous execution context will panic.

Wrapping !Unpin types

Use e.g. SyncIoBridge::new(Box::pin(src)).

Panic

This will panic if called outside the context of a Tokio runtime.

pub fn new_with_handle(src: T, rt: Handle) -> Self

Available on crate feature io-util only.

Use a tokio::io::AsyncRead synchronously as a std::io::Read or a tokio::io::AsyncWrite as a std::io::Write.

This is the same as SyncIoBridge::new, but allows passing an arbitrary handle and hence may be initially invoked outside of an asynchronous context.

Trait Implementations

impl<T: Debug> Debug for SyncIoBridge<T>

Available on crate feature io-util only.

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

Formats the value using the given formatter.

impl<T: AsyncRead + Unpin> Read for SyncIoBridge<T>

Available on crate feature io-util only.

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Read the exact number of bytes required to fill buf.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adapter which will read at most limit bytes from it.

impl<T: AsyncWrite + Unpin> Write for SyncIoBridge<T>

Available on crate feature io-util only.

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>

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

fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adapter for this instance of Write.