Struct futures::io::AllowStdIo

pub struct AllowStdIo<T>(_);

A simple wrapper type which allows types which implement only implement std::io::Read or std::io::Write to be used in contexts which expect an AsyncRead or AsyncWrite.

If these types issue an error with the kind io::ErrorKind::WouldBlock, it is expected that they will notify the current task on readiness. Synchronous std types should not issue errors of this kind and are safe to use in this context. However, using these types with AllowStdIo will cause the event loop to block, so they should be used with care.

Methods

impl<T> AllowStdIo<T>

Important traits for AllowStdIo<T>

impl<T> Read for AllowStdIo<T> where
    T: Read, impl<T> Write for AllowStdIo<T> where
    T: Write, 

pub fn new(io: T) -> AllowStdIo<T>

Creates a new AllowStdIo from an existing IO object.

pub fn get_ref(&self) -> &T

Returns a reference to the contained IO object.

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

Returns a mutable reference to the contained IO object.

pub fn into_inner(self) -> T

Consumes self and returns the contained IO object.

Trait Implementations

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

impl<T> Read for AllowStdIo<T> where     T: Read,

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where     R: Read,

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl<T> PartialOrd<AllowStdIo<T>> for AllowStdIo<T> where     T: PartialOrd<T>,

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

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

fn lt(&self, other: &AllowStdIo<T>) -> bool

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

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

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

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

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

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

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

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

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

Formats the value using the given formatter.

impl<T> Write for AllowStdIo<T> where     T: Write,

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<(), Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

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

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

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

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

This method tests for !=.

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

fn hash<__HT>(&self, state: &mut __HT) where     __HT: 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> AsyncWrite for AllowStdIo<T> where     T: Write,

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

Attempt to write bytes from buf into the object.

fn poll_flush(&mut self, &LocalWaker) -> Poll<Result<(), Error>>

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

fn poll_close(&mut self, lw: &LocalWaker) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_vectored_write(     &mut self,     lw: &LocalWaker,     vec: &[&IoVec] ) -> Poll<Result<usize, Error>>

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

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

Important traits for AllowStdIo<T>

impl<T> Read for AllowStdIo<T> where
    T: Read, impl<T> Write for AllowStdIo<T> where
    T: Write, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Copy for AllowStdIo<T> where     T: Copy,

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Attempt to read from the AsyncRead into buf.

unsafe fn initializer(&self) -> Initializer

Determines if this AsyncReader can work with buffers of uninitialized memory.

fn poll_vectored_read(     &mut self,     lw: &LocalWaker,     vec: &mut [&mut IoVec] ) -> Poll<Result<usize, Error>>

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