Struct tokio_io::io::AllowStdIo

pub struct AllowStdIo<T>(_);

A simple wrapper type which allows types that 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>

pub fn new(io: T) -> Self

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: Debug> Debug for AllowStdIo<T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

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

impl<T: Clone> Clone for 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, 

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

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

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

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

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

This method tests for !=.

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

fn cmp(&self, __arg_0: &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: PartialOrd> PartialOrd for AllowStdIo<T>

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

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

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

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

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

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

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

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

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

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

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

fn hash<__HT: Hasher>(&self, __arg_0: &mut __HT)

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

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

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

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

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

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

Attempts to write an entire buffer into this write.

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

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

fn shutdown(&mut self) -> Poll<(), Error>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

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

Attempt to write bytes from buf into the object.

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

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

fn write_buf<B: Buf>(&mut self, buf: &mut B) -> Poll<usize, Error> where
    Self: Sized, 

Write a Buf into this value, returning how many bytes were written.

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

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

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>

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

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

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

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

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 chars(self) -> Chars<Self>

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an [Iterator] over [char]s.

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

unsafe fn prepare_uninitialized_buffer(&self, buf: &mut [u8]) -> bool

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

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

Attempt to read from the AsyncRead into buf.

fn read_buf<B: BufMut>(&mut self, buf: &mut B) -> Poll<usize, Error> where
    Self: Sized, 

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

fn framed<T: Encoder + Decoder>(self, codec: T) -> Framed<Self, T> where
    Self: AsyncWrite + Sized, 

Deprecated since 0.1.7

: Use tokio_codec::Decoder::framed instead

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

fn split(self) -> (ReadHalf<Self>, WriteHalf<Self>) where
    Self: AsyncWrite + Sized, 

Helper method for splitting this read/write object into two halves.