Struct futures_lite::io::BlockOn [−][src]
pub struct BlockOn<T>(_);
Expand description
Blocks on all async I/O operations and implements std::io
traits.
Sometimes async I/O needs to be used in a blocking manner. If calling future::block_on()
manually all the time becomes too tedious, use this type for more convenient blocking on async
I/O operations.
This type implements traits Read
, Write
, or
Seek
if the inner type implements AsyncRead
, AsyncWrite
, or
AsyncSeek
, respectively.
If writing data through the Write
trait, make sure to flush before
dropping the BlockOn
handle or some buffered data might get lost.
Examples
use futures_lite::io::BlockOn; use futures_lite::pin; use std::io::Read; let reader: &[u8] = b"hello"; pin!(reader); let mut blocking_reader = BlockOn::new(reader); let mut contents = String::new(); // This line blocks - note that there is no await: blocking_reader.read_to_string(&mut contents)?;
Implementations
impl<T> BlockOn<T>
[src]
impl<T> BlockOn<T>
[src]pub fn new(io: T) -> BlockOn<T>ⓘ
[src]
pub fn new(io: T) -> BlockOn<T>ⓘ
[src]Wraps an async I/O handle into a blocking interface.
Examples
use futures_lite::io::BlockOn; use futures_lite::pin; let reader: &[u8] = b"hello"; pin!(reader); let blocking_reader = BlockOn::new(reader);
pub fn get_ref(&self) -> &T
[src]
pub fn get_ref(&self) -> &T
[src]Gets a reference to the async I/O handle.
Examples
use futures_lite::io::BlockOn; use futures_lite::pin; let reader: &[u8] = b"hello"; pin!(reader); let blocking_reader = BlockOn::new(reader); let r = blocking_reader.get_ref();
pub fn get_mut(&mut self) -> &mut T
[src]
pub fn get_mut(&mut self) -> &mut T
[src]Gets a mutable reference to the async I/O handle.
Examples
use futures_lite::io::BlockOn; use futures_lite::pin; let reader: &[u8] = b"hello"; pin!(reader); let mut blocking_reader = BlockOn::new(reader); let r = blocking_reader.get_mut();
pub fn into_inner(self) -> T
[src]
pub fn into_inner(self) -> T
[src]Extracts the inner async I/O handle.
Examples
use futures_lite::io::BlockOn; use futures_lite::pin; let reader: &[u8] = b"hello"; pin!(reader); let blocking_reader = BlockOn::new(reader); let inner = blocking_reader.into_inner();
Trait Implementations
impl<T: AsyncBufRead + Unpin> BufRead for BlockOn<T>
[src]
impl<T: AsyncBufRead + Unpin> BufRead for BlockOn<T>
[src]fn fill_buf(&mut self) -> Result<&[u8]>
[src]
fn fill_buf(&mut self) -> Result<&[u8]>
[src]Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty. Read more
fn consume(&mut self, amt: usize)
[src]
fn consume(&mut self, amt: usize)
[src]Tells this buffer that amt
bytes have been consumed from the buffer,
so they should no longer be returned in calls to read
. Read more
fn read_until(
&mut self,
byte: u8,
buf: &mut Vec<u8, Global>
) -> Result<usize, Error>
1.0.0[src]
fn read_until(
&mut self,
byte: u8,
buf: &mut Vec<u8, Global>
) -> Result<usize, Error>
1.0.0[src]Read all bytes into buf
until the delimiter byte
or EOF is reached. Read more
fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]Read all bytes until a newline (the 0xA
byte) is reached, and append
them to the provided buffer. Read more
impl<T: AsyncRead + Unpin> Read for BlockOn<T>
[src]
impl<T: AsyncRead + Unpin> Read for BlockOn<T>
[src]fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
1.36.0[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>
1.36.0[src]Like read
, except that it reads into a slice of buffers. Read more
fn is_read_vectored(&self) -> bool
[src]
fn is_read_vectored(&self) -> bool
[src]can_vector
)Determines if this Read
er has an efficient read_vectored
implementation. Read more
unsafe fn initializer(&self) -> Initializer
[src]
unsafe fn initializer(&self) -> Initializer
[src]read_initializer
)Determines if this Read
er can work with buffers of uninitialized
memory. Read more
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
1.0.0[src]Read all bytes until EOF in this source, placing them into buf
. Read more
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]Read all bytes until EOF in this source, appending them to buf
. Read more
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
1.6.0[src]Read the exact number of bytes required to fill buf
. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]Creates a “by reference” adaptor for this instance of Read
. Read more
impl<T: AsyncSeek + Unpin> Seek for BlockOn<T>
[src]
impl<T: AsyncSeek + Unpin> Seek for BlockOn<T>
[src]fn seek(&mut self, pos: SeekFrom) -> Result<u64>
[src]
fn seek(&mut self, pos: SeekFrom) -> Result<u64>
[src]Seek to an offset, in bytes, in a stream. Read more
fn rewind(&mut self) -> Result<(), Error>
[src]
fn rewind(&mut self) -> Result<(), Error>
[src]seek_rewind
)Rewind to the beginning of a stream. Read more
impl<T: AsyncWrite + Unpin> Write for BlockOn<T>
[src]
impl<T: AsyncWrite + Unpin> Write for BlockOn<T>
[src]fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]Write a buffer into this writer, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[src]
fn flush(&mut self) -> Result<()>
[src]Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn is_write_vectored(&self) -> bool
[src]
fn is_write_vectored(&self) -> bool
[src]can_vector
)Determines if this Write
r has an efficient write_vectored
implementation. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]Attempts to write an entire buffer into this writer. Read more
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
[src]
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
[src]write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
Auto Trait Implementations
impl<T> RefUnwindSafe for BlockOn<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> Send for BlockOn<T> where
T: Send,
T: Send,
impl<T> Sync for BlockOn<T> where
T: Sync,
T: Sync,
impl<T> Unpin for BlockOn<T> where
T: Unpin,
T: Unpin,
impl<T> UnwindSafe for BlockOn<T> where
T: UnwindSafe,
T: UnwindSafe,