Struct futures_util::io::Chain[−][src]

pub struct Chain<T, U> { /* fields omitted */ }

Expand description

Reader for the chain method.

Implementations

[src]

impl<T, U> Chain<T, U> where
T: AsyncRead,
U: AsyncRead,

[src]

pub fn get_ref(&self) -> (&T, &U)

Gets references to the underlying readers in this Chain.

[src]

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

Gets mutable references to the underlying readers in this Chain.

Care should be taken to avoid modifying the internal I/O state of the underlying readers as doing so may corrupt the internal state of this Chain.

[src]

pub fn get_pin_mut(self: Pin<&mut Self>) -> (Pin<&mut T>, Pin<&mut U>)

Gets pinned mutable references to the underlying readers in this Chain.

Care should be taken to avoid modifying the internal I/O state of the underlying readers as doing so may corrupt the internal state of this Chain.

[src]

pub fn into_inner(self) -> (T, U)

Consumes the Chain, returning the wrapped readers.

Trait Implementations

[src]

impl<T, U> AsyncBufRead for Chain<T, U> where
T: AsyncBufRead,
U: AsyncBufRead,

[src]

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

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

[src]

fn consume(self: Pin<&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 poll_read. Read more

[src]

impl<T, U> AsyncRead for Chain<T, U> where
T: AsyncRead,
U: AsyncRead,

[src]

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

Attempt to read from the AsyncRead into buf. Read more

[src]

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

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

[src]

impl<T, U> Debug for Chain<T, U> where
T: Debug,
U: Debug,

[src]

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

Formats the value using the given formatter. Read more

[src]

impl<'pin, T, U> Unpin for Chain<T, U> where
Origin<'__pin, T, U>: Unpin,

Auto Trait Implementations

impl<T, U> RefUnwindSafe for Chain<T, U> where
T: RefUnwindSafe,
U: RefUnwindSafe,

impl<T, U> Send for Chain<T, U> where
T: Send,
U: Send,

impl<T, U> Sync for Chain<T, U> where
T: Sync,
U: Sync,

impl<T, U> UnwindSafe for Chain<T, U> where
T: UnwindSafe,
U: UnwindSafe,

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,

[src]

fn fill_buf(&mut self) -> FillBuf<'_, Self>ⓘ
Notable traits for FillBuf<'a, R>
`impl<'a, R> Future for FillBuf<'a, R> where R: AsyncBufRead + ?Sized + Unpin, type Output = Result<&'a [u8]>;`
where
Self: Unpin,

Creates a future which will wait for a non-empty buffer to be available from this I/O object or EOF to be reached. Read more

[src]

fn consume_unpin(&mut self, amt: usize) where
Self: Unpin,

A convenience for calling AsyncBufRead::consume on Unpin IO types. Read more

[src]

fn read_until<'a>(
 &'a mut self,
 byte: u8,
 buf: &'a mut Vec<u8>
) -> ReadUntil<'a, Self>ⓘ
Notable traits for ReadUntil<'_, R>
`impl<R: AsyncBufRead + ?Sized + Unpin> Future for ReadUntil<'_, R> type Output = Result<usize>;`
where
 Self: Unpin,

Creates a future which will read all the bytes associated with this I/O object into buf until the delimiter byte or EOF is reached. This method is the async equivalent to BufRead::read_until. Read more

[src]

fn read_line<'a>(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self>ⓘ
Notable traits for ReadLine<'_, R>
`impl<R: AsyncBufRead + ?Sized + Unpin> Future for ReadLine<'_, R> type Output = Result<usize>;`
where
Self: Unpin,

Creates a future which will read all the bytes associated with this I/O object into buf until a newline (the 0xA byte) or EOF is reached, This method is the async equivalent to BufRead::read_line. Read more

[src]

fn lines(self) -> Lines<Self> where
Self: Sized,

Returns a stream over the lines of this reader. This method is the async equivalent to BufRead::lines. Read more

[src]

impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,

[src]

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

Creates an adaptor which will chain this stream with another. Read more

[src]

fn read<'a>(&'a mut self, buf: &'a mut [u8 ]) -> Read<'a, Self>ⓘ
Notable traits for Read<'_, R>
`impl<R: AsyncRead + ?Sized + Unpin> Future for Read<'_, R> type Output = Result<usize>;`
where
Self: Unpin,

Tries to read some bytes directly into the given buf in asynchronous manner, returning a future type. Read more

[src]

fn read_vectored<'a>(
 &'a mut self,
 bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>ⓘ
Notable traits for ReadVectored<'_, R>
`impl<R: AsyncRead + ?Sized + Unpin> Future for ReadVectored<'_, R> type Output = Result<usize>;`
where
 Self: Unpin,

Creates a future which will read from the AsyncRead into bufs using vectored IO operations. Read more

[src]

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8 ]) -> ReadExact<'a, Self>ⓘ
Notable traits for ReadExact<'_, R>
`impl<R: AsyncRead + ?Sized + Unpin> Future for ReadExact<'_, R> type Output = Result<()>;`
where
Self: Unpin,

Creates a future which will read exactly enough bytes to fill buf, returning an error if end of file (EOF) is hit sooner. Read more

[src]

fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>ⓘ
Notable traits for ReadToEnd<'_, A>
`impl<A> Future for ReadToEnd<'_, A> where A: AsyncRead + ?Sized + Unpin, type Output = Result<usize>;`
where
Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more

[src]

fn read_to_string<'a>(
 &'a mut self,
 buf: &'a mut String
) -> ReadToString<'a, Self>ⓘ
Notable traits for ReadToString<'_, A>
`impl<A> Future for ReadToString<'_, A> where A: AsyncRead + ?Sized + Unpin, type Output = Result<usize>;`
where
 Self: Unpin,

Creates a future which will read all the bytes from this AsyncRead. Read more

[src]

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

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

[src]

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

Creates an AsyncRead adapter which will read at most limit bytes from the underlying reader. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct futures_util::io::Chain[−][src]

Implementations

impl<T, U> Chain<T, U> where T: AsyncRead, U: AsyncRead,

pub fn get_ref(&self) -> (&T, &U)

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

pub fn get_pin_mut(self: Pin<&mut Self>) -> (Pin<&mut T>, Pin<&mut U>)

pub fn into_inner(self) -> (T, U)

Trait Implementations

impl<T, U> AsyncBufRead for Chain<T, U> where T: AsyncBufRead, U: AsyncBufRead,

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

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

impl<T, U> AsyncRead for Chain<T, U> where T: AsyncRead, U: AsyncRead,

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

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

impl<T, U> Debug for Chain<T, U> where T: Debug, U: Debug,

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

impl<'__pin, T, U> Unpin for Chain<T, U> where __Origin<'__pin, T, U>: Unpin,

Auto Trait Implementations

impl<T, U> RefUnwindSafe for Chain<T, U> where T: RefUnwindSafe, U: RefUnwindSafe,

impl<T, U> Send for Chain<T, U> where T: Send, U: Send,

impl<T, U> Sync for Chain<T, U> where T: Sync, U: Sync,

impl<T, U> UnwindSafe for Chain<T, U> where T: UnwindSafe, U: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<R> AsyncBufReadExt for R where R: AsyncBufRead + ?Sized,

fn fill_buf(&mut self) -> FillBuf<'_, Self>ⓘNotable traits for FillBuf<'a, R>impl<'a, R> Future for FillBuf<'a, R> where R: AsyncBufRead + ?Sized + Unpin, type Output = Result<&'a [u8]>; where Self: Unpin,

fn consume_unpin(&mut self, amt: usize) where Self: Unpin,

fn read_until<'a>( &'a mut self, byte: u8, buf: &'a mut Vec<u8>) -> ReadUntil<'a, Self>ⓘNotable traits for ReadUntil<'_, R>impl<R: AsyncBufRead + ?Sized + Unpin> Future for ReadUntil<'_, R> type Output = Result<usize>; where Self: Unpin,

fn read_line<'a>(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self>ⓘNotable traits for ReadLine<'_, R>impl<R: AsyncBufRead + ?Sized + Unpin> Future for ReadLine<'_, R> type Output = Result<usize>; where Self: Unpin,

fn lines(self) -> Lines<Self> where Self: Sized,

impl<R> AsyncReadExt for R where R: AsyncRead + ?Sized,

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

fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>ⓘNotable traits for Read<'_, R>impl<R: AsyncRead + ?Sized + Unpin> Future for Read<'_, R> type Output = Result<usize>; where Self: Unpin,

fn read_vectored<'a>( &'a mut self, bufs: &'a mut [IoSliceMut<'a>]) -> ReadVectored<'a, Self>ⓘNotable traits for ReadVectored<'_, R>impl<R: AsyncRead + ?Sized + Unpin> Future for ReadVectored<'_, R> type Output = Result<usize>; where Self: Unpin,

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>ⓘNotable traits for ReadExact<'_, R>impl<R: AsyncRead + ?Sized + Unpin> Future for ReadExact<'_, R> type Output = Result<()>; where Self: Unpin,

fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>ⓘNotable traits for ReadToEnd<'_, A>impl<A> Future for ReadToEnd<'_, A> where A: AsyncRead + ?Sized + Unpin, type Output = Result<usize>; where Self: Unpin,

fn read_to_string<'a>( &'a mut self, buf: &'a mut String) -> ReadToString<'a, Self>ⓘNotable traits for ReadToString<'_, A>impl<A> Future for ReadToString<'_, A> where A: AsyncRead + ?Sized + Unpin, type Output = Result<usize>; where Self: Unpin,

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

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

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T, U> Chain<T, U> where
T: AsyncRead,
U: AsyncRead,

impl<T, U> AsyncBufRead for Chain<T, U> where
T: AsyncBufRead,
U: AsyncBufRead,

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

impl<T, U> AsyncRead for Chain<T, U> where
T: AsyncRead,
U: AsyncRead,

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

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

impl<T, U> Debug for Chain<T, U> where
T: Debug,
U: Debug,

impl<'pin, T, U> Unpin for Chain<T, U> where
Origin<'__pin, T, U>: Unpin,

impl<T, U> RefUnwindSafe for Chain<T, U> where
T: RefUnwindSafe,
U: RefUnwindSafe,

impl<T, U> Send for Chain<T, U> where
T: Send,
U: Send,

impl<T, U> Sync for Chain<T, U> where
T: Sync,
U: Sync,

impl<T, U> UnwindSafe for Chain<T, U> where
T: UnwindSafe,
U: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<R> AsyncBufReadExt for R where
R: AsyncBufRead + ?Sized,

fn fill_buf(&mut self) -> FillBuf<'_, Self>ⓘ
Notable traits for FillBuf<'a, R>
`impl<'a, R> Future for FillBuf<'a, R> where R: AsyncBufRead + ?Sized + Unpin, type Output = Result<&'a [u8]>;`
where
Self: Unpin,

fn consume_unpin(&mut self, amt: usize) where
Self: Unpin,

fn read_until<'a>(
&'a mut self,
byte: u8,
buf: &'a mut Vec<u8>
) -> ReadUntil<'a, Self>ⓘ
Notable traits for ReadUntil<'_, R>
`impl<R: AsyncBufRead + ?Sized + Unpin> Future for ReadUntil<'_, R> type Output = Result<usize>;`
where
Self: Unpin,

fn read_line<'a>(&'a mut self, buf: &'a mut String) -> ReadLine<'a, Self>ⓘ
Notable traits for ReadLine<'_, R>
`impl<R: AsyncBufRead + ?Sized + Unpin> Future for ReadLine<'_, R> type Output = Result<usize>;`
where
Self: Unpin,

fn lines(self) -> Lines<Self> where
Self: Sized,

impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,

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

fn read<'a>(&'a mut self, buf: &'a mut [u8 ]) -> Read<'a, Self>ⓘ
Notable traits for Read<'_, R>
`impl<R: AsyncRead + ?Sized + Unpin> Future for Read<'_, R> type Output = Result<usize>;`
where
Self: Unpin,

fn read_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectored<'a, Self>ⓘ
Notable traits for ReadVectored<'_, R>
`impl<R: AsyncRead + ?Sized + Unpin> Future for ReadVectored<'_, R> type Output = Result<usize>;`
where
Self: Unpin,

fn read_exact<'a>(&'a mut self, buf: &'a mut [u8 ]) -> ReadExact<'a, Self>ⓘ
Notable traits for ReadExact<'_, R>
`impl<R: AsyncRead + ?Sized + Unpin> Future for ReadExact<'_, R> type Output = Result<()>;`
where
Self: Unpin,

fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>ⓘ
Notable traits for ReadToEnd<'_, A>
`impl<A> Future for ReadToEnd<'_, A> where A: AsyncRead + ?Sized + Unpin, type Output = Result<usize>;`
where
Self: Unpin,

fn read_to_string<'a>(
&'a mut self,
buf: &'a mut String
) -> ReadToString<'a, Self>ⓘ
Notable traits for ReadToString<'_, A>
`impl<A> Future for ReadToString<'_, A> where A: AsyncRead + ?Sized + Unpin, type Output = Result<usize>;`
where
Self: Unpin,

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

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,