Struct smol_potat::io::AssertAsync

pub struct AssertAsync<T>(_);

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::*;

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

future::block_on(async {
let mut async_reader = io::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) -> AssertAsync<T>

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

Examples

use futures_lite::*;

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

let async_reader = io::AssertAsync::new(reader);

pub fn get_ref(&self) -> &Tⓘ

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

Gets a reference to the inner I/O handle.

Examples

use futures_lite::*;

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

let async_reader = io::AssertAsync::new(reader);
let r = async_reader.get_ref();

pub fn get_mut(&mut self) -> &mut Tⓘ

Important traits for &'_ mut F

impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized,  type Output = <F as Future>::Output;

Gets a mutable reference to the inner I/O handle.

Examples

use futures_lite::*;

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

let mut async_reader = io::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::*;

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

let async_reader = io::AssertAsync::new(reader);
let inner = async_reader.into_inner();

Trait Implementations

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

fn poll_read(
    self: Pin<&mut AssertAsync<T>>,
    &mut Context,
    buf: &mut [u8]
) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored(
    self: Pin<&mut AssertAsync<T>>,
    &mut Context,
    bufs: &mut [IoSliceMut]
) -> Poll<Result<usize, Error>>

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

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

fn poll_seek(
    self: Pin<&mut AssertAsync<T>>,
    &mut Context,
    pos: SeekFrom
) -> Poll<Result<u64, Error>>

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

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

fn poll_write(
    self: Pin<&mut AssertAsync<T>>,
    &mut Context,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

fn poll_write_vectored(
    self: Pin<&mut AssertAsync<T>>,
    &mut Context,
    bufs: &[IoSlice]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.

fn poll_flush(
    self: Pin<&mut AssertAsync<T>>,
    &mut Context
) -> Poll<Result<(), Error>>

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

fn poll_close(
    self: Pin<&mut AssertAsync<T>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

Attempt to close the object.

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

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> Copy for AssertAsync<T> where
    T: Copy, 

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

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

Formats the value using the given formatter.

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

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

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

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

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl<T> PartialOrd<AssertAsync<T>> for AssertAsync<T> where
    T: PartialOrd<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: &AssertAsync<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Unpin for AssertAsync<T>