Struct tokio_util::io::SyncIoBridge [−][src]
pub struct SyncIoBridge<T> { /* fields omitted */ }
io
only.Expand description
Use a tokio::io::AsyncRead
synchronously as a std::io::Read
or
a tokio::io::AsyncWrite
as a std::io::Write
.
Implementations
This is supported on crate feature io-util
only.
io-util
only.Determines if the underlying tokio::io::AsyncWrite
target supports efficient vectored writes.
This is supported on crate feature io-util
only.
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.
This is supported on crate feature io-util
only.
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
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
Read all bytes until EOF in this source, placing them into buf
. Read more
Read all bytes until EOF in this source, appending them to buf
. Read more
Read the exact number of bytes required to fill buf
. Read more
Like read
, except that it reads into a slice of buffers. Read more
can_vector
)Determines if this Read
er has an efficient read_vectored
implementation. Read more
read_initializer
)Determines if this Read
er can work with buffers of uninitialized
memory. Read more
Creates a “by reference” adapter for this instance of Read
. Read more
Creates an adapter which will chain this stream with another. Read more
impl<T: AsyncWrite + Unpin> Write for SyncIoBridge<T>
This is supported on crate feature io-util
only.
impl<T: AsyncWrite + Unpin> Write for SyncIoBridge<T>
io-util
only.Write a buffer into this writer, returning how many bytes were written. Read more
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
Attempts to write an entire buffer into this writer. Read more
can_vector
)Determines if this Write
r has an efficient write_vectored
implementation. Read more
write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
Writes a formatted string into this writer, returning any error encountered. Read more