[][src]Struct tokio::io::BufStream

pub struct BufStream<RW> { /* fields omitted */ }

Wraps a type that is [AsyncWrite] and [AsyncRead], and buffers its input and output.

It can be excessively inefficient to work directly with something that implements [AsyncWrite] and [AsyncRead]. For example, every write, however small, has to traverse the syscall interface, and similarly, every read has to do the same. The [BufWriter] and [BufReader] types aid with these problems respectively, but do so in only one direction. BufStream wraps one in the other so that both directions are buffered. See their documentation for details.

Implementations

impl<RW: AsyncRead + AsyncWrite> BufStream<RW>[src]

pub fn new(stream: RW) -> BufStream<RW>[src]

Wraps a type in both [BufWriter] and [BufReader].

See the documentation for those types and [BufStream] for details.

pub fn with_capacity(
    reader_capacity: usize,
    writer_capacity: usize,
    stream: RW
) -> BufStream<RW>
[src]

Creates a BufStream with the specified [BufReader] capacity and [BufWriter] capacity.

See the documentation for those types and [BufStream] for details.

pub fn get_ref(&self) -> &RW

Notable traits for &'_ mut F

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

Gets a reference to the underlying I/O object.

It is inadvisable to directly read from the underlying I/O object.

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

Notable traits for &'_ mut F

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

Gets a mutable reference to the underlying I/O object.

It is inadvisable to directly read from the underlying I/O object.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut RW>

Notable traits for Pin<P>

impl<P> Future for Pin<P> where
    P: Unpin + DerefMut,
    <P as Deref>::Target: Future
type Output = <<P as Deref>::Target as Future>::Output;
[src]

Gets a pinned mutable reference to the underlying I/O object.

It is inadvisable to directly read from the underlying I/O object.

pub fn into_inner(self) -> RW[src]

Consumes this BufStream, returning the underlying I/O object.

Note that any leftover data in the internal buffer is lost.

Trait Implementations

impl<RW: AsyncRead + AsyncWrite> AsyncBufRead for BufStream<RW>[src]

impl<RW: AsyncRead + AsyncWrite> AsyncRead for BufStream<RW>[src]

impl<RW: AsyncRead + AsyncWrite> AsyncWrite for BufStream<RW>[src]

impl<RW: Debug> Debug for BufStream<RW>[src]

impl<RW> From<BufReader<BufWriter<RW>>> for BufStream<RW>[src]

impl<RW> From<BufWriter<BufReader<RW>>> for BufStream<RW>[src]

impl<'__pin, RW> Unpin for BufStream<RW> where
    __Origin<'__pin, RW>: Unpin
[src]

Auto Trait Implementations

impl<RW> RefUnwindSafe for BufStream<RW> where
    RW: RefUnwindSafe

impl<RW> Send for BufStream<RW> where
    RW: Send

impl<RW> Sync for BufStream<RW> where
    RW: Sync

impl<RW> UnwindSafe for BufStream<RW> where
    RW: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.