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> Write for AllowStdIo<T> where
    T: Write, impl<T> Read for AllowStdIo<T> where
    T: Read, 

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

Creates a new AllowStdIo from an existing IO object.

Important traits for &'_ mut F

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

pub fn get_ref(&self) -> &T

Returns a reference to the contained IO object.

Important traits for &'_ mut F

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

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> Unpin for AllowStdIo<T>

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

Important traits for AllowStdIo<T>

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

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> Seek for AllowStdIo<T> where
    T: Seek, 

fn seek(&mut self, pos: SeekFrom) -> Result<u64, Error>

Seek to an offset, in bytes, in a stream.

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

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

Returns the length of this stream (in bytes).

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

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

Returns the current seek position from the start of the stream.

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> 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> Write for AllowStdIo<T> where
    T: Write, 

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

Write a buffer into this writer, 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 writer.

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

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

fn write_vectored(&mut self, bufs: &[IoVec]) -> Result<usize, Error>

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

Like write, except that it writes from a slice of buffers.

Important traits for &'_ mut F

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

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

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

impl<T> AsyncBufRead for AllowStdIo<T> where
    T: BufRead, 

fn poll_fill_buf(
    self: Pin<&'a mut AllowStdIo<T>>,
    &mut Context
) -> Poll<Result<&'a [u8], Error>>

Attempt to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut AllowStdIo<T>>, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to [poll_read].

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

fn fill_buf(&mut self) -> Result<&[u8], Error>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

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

Read all bytes into buf until the delimiter byte or EOF is reached.

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

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

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> 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.

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> Eq for AllowStdIo<T> where
    T: Eq, 

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

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

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

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

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

fn poll_read(
    self: Pin<&mut AllowStdIo<T>>,
    &mut Context,
    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(
    self: Pin<&mut Self>,
    cx: &mut Context,
    vec: &mut [&mut IoVec]
) -> Poll<Result<usize, Error>>

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

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.

fn read_vectored(&mut self, bufs: &mut [IoVecMut]) -> Result<usize, Error>

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

Like read, except that it reads into a slice of buffers.

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.

Important traits for &'_ mut F

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

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> AsyncWrite for AllowStdIo<T> where
    T: Write, 

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

Attempt to write bytes from buf into the object.

fn poll_flush(
    self: Pin<&mut AllowStdIo<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 AllowStdIo<T>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

Attempt to close the object.

fn poll_vectored_write(
    self: Pin<&mut Self>,
    cx: &mut Context,
    vec: &[&IoVec]
) -> Poll<Result<usize, Error>>

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

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 !=.