Struct futures_lite::io::AssertAsync
source · [−]pub struct AssertAsync<T>(_);
Expand description
Asserts that a type implementing std::io
traits can be used as an async type.
The underlying I/O handle should never block nor return the ErrorKind::WouldBlock
error.
This is usually the case for in-memory buffered I/O.
Examples
use futures_lite::io::{AssertAsync, AsyncReadExt};
let reader: &[u8] = b"hello";
let mut async_reader = AssertAsync::new(reader);
let mut contents = String::new();
// This line works in async manner - note that there is await:
async_reader.read_to_string(&mut contents).await?;
Implementations
sourceimpl<T> AssertAsync<T>
impl<T> AssertAsync<T>
sourcepub fn get_ref(&self) -> &T
pub fn get_ref(&self) -> &T
Gets a reference to the inner I/O handle.
Examples
use futures_lite::io::AssertAsync;
let reader: &[u8] = b"hello";
let async_reader = AssertAsync::new(reader);
let r = async_reader.get_ref();
sourcepub fn get_mut(&mut self) -> &mut T
pub fn get_mut(&mut self) -> &mut T
Gets a mutable reference to the inner I/O handle.
Examples
use futures_lite::io::AssertAsync;
let reader: &[u8] = b"hello";
let mut async_reader = AssertAsync::new(reader);
let r = async_reader.get_mut();
sourcepub fn into_inner(self) -> T
pub fn into_inner(self) -> T
Extracts the inner I/O handle.
Examples
use futures_lite::io::AssertAsync;
let reader: &[u8] = b"hello";
let async_reader = AssertAsync::new(reader);
let inner = async_reader.into_inner();
Trait Implementations
sourceimpl<T: Read> AsyncRead for AssertAsync<T>
impl<T: Read> AsyncRead for AssertAsync<T>
sourceimpl<T: Seek> AsyncSeek for AssertAsync<T>
impl<T: Seek> AsyncSeek for AssertAsync<T>
sourceimpl<T: Write> AsyncWrite for AssertAsync<T>
impl<T: Write> AsyncWrite for AssertAsync<T>
sourcefn poll_write(
self: Pin<&mut Self>,
_: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
fn poll_write(
self: Pin<&mut Self>,
_: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
Attempt to write bytes from buf
into the object. Read more
sourcefn poll_write_vectored(
self: Pin<&mut Self>,
_: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>
fn poll_write_vectored(
self: Pin<&mut Self>,
_: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>
Attempt to write bytes from bufs
into the object using vectored
IO operations. Read more
sourceimpl<T: Clone> Clone for AssertAsync<T>
impl<T: Clone> Clone for AssertAsync<T>
sourcefn clone(&self) -> AssertAsync<T>
fn clone(&self) -> AssertAsync<T>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<T: Debug> Debug for AssertAsync<T>
impl<T: Debug> Debug for AssertAsync<T>
sourceimpl<T: Hash> Hash for AssertAsync<T>
impl<T: Hash> Hash for AssertAsync<T>
sourceimpl<T: Ord> Ord for AssertAsync<T>
impl<T: Ord> Ord for AssertAsync<T>
sourceimpl<T: PartialEq> PartialEq<AssertAsync<T>> for AssertAsync<T>
impl<T: PartialEq> PartialEq<AssertAsync<T>> for AssertAsync<T>
sourcefn eq(&self, other: &AssertAsync<T>) -> bool
fn eq(&self, other: &AssertAsync<T>) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &AssertAsync<T>) -> bool
fn ne(&self, other: &AssertAsync<T>) -> bool
This method tests for !=
.
sourceimpl<T: PartialOrd> PartialOrd<AssertAsync<T>> for AssertAsync<T>
impl<T: PartialOrd> PartialOrd<AssertAsync<T>> for AssertAsync<T>
sourcefn partial_cmp(&self, other: &AssertAsync<T>) -> Option<Ordering>
fn partial_cmp(&self, other: &AssertAsync<T>) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl<T: Copy> Copy for AssertAsync<T>
impl<T: Eq> Eq for AssertAsync<T>
impl<T> StructuralEq for AssertAsync<T>
impl<T> StructuralPartialEq for AssertAsync<T>
impl<T> Unpin for AssertAsync<T>
Auto Trait Implementations
impl<T> RefUnwindSafe for AssertAsync<T> where
T: RefUnwindSafe,
impl<T> Send for AssertAsync<T> where
T: Send,
impl<T> Sync for AssertAsync<T> where
T: Sync,
impl<T> UnwindSafe for AssertAsync<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
sourcefn read<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self>ⓘNotable traits for ReadFuture<'_, R>impl<R: AsyncRead + Unpin + ?Sized> Future for ReadFuture<'_, R> type Output = Result<usize>;
where
Self: Unpin,
fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self>ⓘNotable traits for ReadFuture<'_, R>impl<R: AsyncRead + Unpin + ?Sized> Future for ReadFuture<'_, R> type Output = Result<usize>;
where
Self: Unpin,
Reads some bytes from the byte stream. Read more
sourcefn read_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self>ⓘNotable traits for ReadVectoredFuture<'_, R>impl<R: AsyncRead + Unpin + ?Sized> Future for ReadVectoredFuture<'_, R> type Output = Result<usize>;
where
Self: Unpin,
fn read_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self>ⓘNotable traits for ReadVectoredFuture<'_, R>impl<R: AsyncRead + Unpin + ?Sized> Future for ReadVectoredFuture<'_, R> type Output = Result<usize>;
where
Self: Unpin,
sourcefn read_to_end<'a>(
&'a mut self,
buf: &'a mut Vec<u8>
) -> ReadToEndFuture<'a, Self>ⓘNotable traits for ReadToEndFuture<'_, R>impl<R: AsyncRead + Unpin + ?Sized> Future for ReadToEndFuture<'_, R> type Output = Result<usize>;
where
Self: Unpin,
fn read_to_end<'a>(
&'a mut self,
buf: &'a mut Vec<u8>
) -> ReadToEndFuture<'a, Self>ⓘNotable traits for ReadToEndFuture<'_, R>impl<R: AsyncRead + Unpin + ?Sized> Future for ReadToEndFuture<'_, R> type Output = Result<usize>;
where
Self: Unpin,
sourcefn read_to_string<'a>(
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self>ⓘNotable traits for ReadToStringFuture<'_, R>impl<R: AsyncRead + Unpin + ?Sized> Future for ReadToStringFuture<'_, R> type Output = Result<usize>;
where
Self: Unpin,
fn read_to_string<'a>(
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self>ⓘNotable traits for ReadToStringFuture<'_, R>impl<R: AsyncRead + Unpin + ?Sized> Future for ReadToStringFuture<'_, R> type Output = Result<usize>;
where
Self: Unpin,
sourcefn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self>ⓘNotable traits for ReadExactFuture<'_, R>impl<R: AsyncRead + Unpin + ?Sized> Future for ReadExactFuture<'_, R> type Output = Result<()>;
where
Self: Unpin,
fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self>ⓘNotable traits for ReadExactFuture<'_, R>impl<R: AsyncRead + Unpin + ?Sized> Future for ReadExactFuture<'_, R> type Output = Result<()>;
where
Self: Unpin,
Reads the exact number of bytes required to fill buf
. Read more
sourcefn take(self, limit: u64) -> Take<Self> where
Self: Sized,
fn take(self, limit: u64) -> Take<Self> where
Self: Sized,
Creates an adapter which will read at most limit
bytes from it. Read more
sourceimpl<S> AsyncSeekExt for S where
S: AsyncSeek + ?Sized,
impl<S> AsyncSeekExt for S where
S: AsyncSeek + ?Sized,
sourcefn seek(&mut self, pos: SeekFrom) -> SeekFuture<'_, Self>ⓘNotable traits for SeekFuture<'_, S>impl<S: AsyncSeek + Unpin + ?Sized> Future for SeekFuture<'_, S> type Output = Result<u64>;
where
Self: Unpin,
fn seek(&mut self, pos: SeekFrom) -> SeekFuture<'_, Self>ⓘNotable traits for SeekFuture<'_, S>impl<S: AsyncSeek + Unpin + ?Sized> Future for SeekFuture<'_, S> type Output = Result<u64>;
where
Self: Unpin,
Seeks to a new position in a byte stream. Read more
sourceimpl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,
impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,
sourcefn write<'a>(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>ⓘNotable traits for WriteFuture<'_, W>impl<W: AsyncWrite + Unpin + ?Sized> Future for WriteFuture<'_, W> type Output = Result<usize>;
where
Self: Unpin,
fn write<'a>(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>ⓘNotable traits for WriteFuture<'_, W>impl<W: AsyncWrite + Unpin + ?Sized> Future for WriteFuture<'_, W> type Output = Result<usize>;
where
Self: Unpin,
Writes some bytes into the byte stream. Read more
sourcefn write_vectored<'a>(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self>ⓘNotable traits for WriteVectoredFuture<'_, W>impl<W: AsyncWrite + Unpin + ?Sized> Future for WriteVectoredFuture<'_, W> type Output = Result<usize>;
where
Self: Unpin,
fn write_vectored<'a>(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self>ⓘNotable traits for WriteVectoredFuture<'_, W>impl<W: AsyncWrite + Unpin + ?Sized> Future for WriteVectoredFuture<'_, W> type Output = Result<usize>;
where
Self: Unpin,
sourcefn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>ⓘNotable traits for WriteAllFuture<'_, W>impl<W: AsyncWrite + Unpin + ?Sized> Future for WriteAllFuture<'_, W> type Output = Result<()>;
where
Self: Unpin,
fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>ⓘNotable traits for WriteAllFuture<'_, W>impl<W: AsyncWrite + Unpin + ?Sized> Future for WriteAllFuture<'_, W> type Output = Result<()>;
where
Self: Unpin,
Writes an entire buffer into the byte stream. Read more
sourcefn flush(&mut self) -> FlushFuture<'_, Self>ⓘNotable traits for FlushFuture<'_, W>impl<W: AsyncWrite + Unpin + ?Sized> Future for FlushFuture<'_, W> type Output = Result<()>;
where
Self: Unpin,
fn flush(&mut self) -> FlushFuture<'_, Self>ⓘNotable traits for FlushFuture<'_, W>impl<W: AsyncWrite + Unpin + ?Sized> Future for FlushFuture<'_, W> type Output = Result<()>;
where
Self: Unpin,
Flushes the stream to ensure that all buffered contents reach their destination. Read more
sourcefn close(&mut self) -> CloseFuture<'_, Self>ⓘNotable traits for CloseFuture<'_, W>impl<W: AsyncWrite + Unpin + ?Sized> Future for CloseFuture<'_, W> type Output = Result<()>;
where
Self: Unpin,
fn close(&mut self) -> CloseFuture<'_, Self>ⓘNotable traits for CloseFuture<'_, W>impl<W: AsyncWrite + Unpin + ?Sized> Future for CloseFuture<'_, W> type Output = Result<()>;
where
Self: Unpin,
Closes the writer. Read more
sourcefn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a>> where
Self: Sized + Send + 'a,
fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a>> where
Self: Sized + Send + 'a,
Boxes the writer and changes its type to dyn AsyncWrite + Send + 'a
. Read more
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more