[][src]Struct tokio::io::BufReader

pub struct BufReader<R> { /* fields omitted */ }

The BufReader struct adds buffering to any reader.

It can be excessively inefficient to work directly with a [AsyncRead] instance. A BufReader performs large, infrequent reads on the underlying [AsyncRead] and maintains an in-memory buffer of the results.

BufReader can improve the speed of programs that make small and repeated read calls to the same file or network socket. It does not help when reading very large amounts at once, or reading just one or a few times. It also provides no advantage when reading from a source that is already in memory, like a Vec<u8>.

When the BufReader is dropped, the contents of its buffer will be discarded. Creating multiple instances of a BufReader on the same stream can cause data loss.

Implementations

impl<R: AsyncRead> BufReader<R>[src]

pub fn new(inner: R) -> Self[src]

Creates a new BufReader with a default buffer capacity. The default is currently 8 KB, but may change in the future.

pub fn with_capacity(capacity: usize, inner: R) -> Self[src]

Creates a new BufReader with the specified buffer capacity.

pub fn get_ref(&self) -> &R

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

It is inadvisable to directly read from the underlying reader.

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

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

It is inadvisable to directly read from the underlying reader.

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

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

It is inadvisable to directly read from the underlying reader.

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

Consumes this BufReader, returning the underlying reader.

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

pub fn buffer(&self) -> &[u8][src]

Returns a reference to the internally buffered data.

Unlike fill_buf, this will not attempt to fill the buffer if it is empty.

Trait Implementations

impl<R: AsyncRead> AsyncBufRead for BufReader<R>[src]

impl<R: AsyncRead> AsyncRead for BufReader<R>[src]

impl<R: AsyncRead + AsyncWrite> AsyncWrite for BufReader<R>[src]

impl<R: Debug> Debug for BufReader<R>[src]

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

impl<'__pin, R> Unpin for BufReader<R> where
    __Origin<'__pin, R>: Unpin
[src]

Auto Trait Implementations

impl<R> RefUnwindSafe for BufReader<R> where
    R: RefUnwindSafe

impl<R> Send for BufReader<R> where
    R: Send

impl<R> Sync for BufReader<R> where
    R: Sync

impl<R> UnwindSafe for BufReader<R> where
    R: 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.