Struct futures_lite::io::AssertAsync

pub struct AssertAsync<T>(/* private fields */);

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

impl<T> AssertAsync<T>

pub fn new(io: T) -> Self

Wraps an I/O handle implementing std::io traits.

Examples

use futures_lite::io::AssertAsync;

let reader: &[u8] = b"hello";

let async_reader = AssertAsync::new(reader);

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();

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();

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

impl<T: Read> AsyncRead for AssertAsync<T>

fn poll_read( self: Pin<&mut Self>, _: &mut Context<'_>, buf: &mut [u8], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, _: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl<T: Seek> AsyncSeek for AssertAsync<T>

fn poll_seek( self: Pin<&mut Self>, _: &mut Context<'_>, pos: SeekFrom, ) -> Poll<Result<u64>>

Attempt to seek to an offset, in bytes, in a stream.

impl<T: Write> AsyncWrite for AssertAsync<T>

fn poll_write( self: Pin<&mut Self>, _: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

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.

fn poll_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

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

Attempt to close the object.

impl<T: Clone> Clone for AssertAsync<T>

fn clone(&self) -> AssertAsync<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for AssertAsync<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for AssertAsync<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for AssertAsync<T>

fn cmp(&self, other: &AssertAsync<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for AssertAsync<T>

fn eq(&self, other: &AssertAsync<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for AssertAsync<T>

fn partial_cmp(&self, other: &AssertAsync<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: Copy> Copy for AssertAsync<T>

impl<T: Eq> Eq for AssertAsync<T>

impl<T> StructuralPartialEq for AssertAsync<T>

impl<T> Unpin for AssertAsync<T>