Struct futures_util::io::ReadHalf

source · [−]

pub struct ReadHalf<T> { /* private fields */ }

Expand description

The readable half of an object returned from AsyncRead::split.

Implementations

source

impl<T: Unpin> ReadHalf<T>

source

pub fn reunite(self, other: WriteHalf<T>) -> Result<T, ReuniteError<T>>

Attempts to put the two “halves” of a split AsyncRead + AsyncWrite back together. Succeeds only if the ReadHalf<T> and WriteHalf<T> are a matching pair originating from the same call to AsyncReadExt::split.

Trait Implementations

source

impl<R: AsyncRead> AsyncRead for ReadHalf<R>

source

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

source

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

source

impl<T: Debug> Debug for ReadHalf<T>

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<T> !RefUnwindSafe for ReadHalf<T>

impl<T> Send for ReadHalf<T>where
T: Send,

impl<T> Sync for ReadHalf<T>where
T: Send,

impl<T> Unpin for ReadHalf<T>

impl<T> !UnwindSafe for ReadHalf<T>

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

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

source

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

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

const: unstable

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable

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

Performs the conversion.

Struct futures_util::io::ReadHalf

Implementations

impl<T: Unpin> ReadHalf<T>

pub fn reunite(self, other: WriteHalf<T>) -> Result<T, ReuniteError<T>>

Trait Implementations

impl<R: AsyncRead> AsyncRead for ReadHalf<R>

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

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

Auto Trait Implementations

impl<T> !RefUnwindSafe for ReadHalf<T>

impl<T> Send for ReadHalf<T>where T: Send,

impl<T> Sync for ReadHalf<T>where T: Send,

impl<T> Unpin for ReadHalf<T>

impl<T> !UnwindSafe for ReadHalf<T>

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<R> AsyncReadExt for Rwhere 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 Twhere T: ?Sized,

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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> Send for ReadHalf<T>where
T: Send,

impl<T> Sync for ReadHalf<T>where
T: Send,

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

impl<R> AsyncReadExt for Rwhere
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 Twhere
T: ?Sized,

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

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

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

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