Struct tokio::io::BufReader [−][src]
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ⓘ
[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ⓘ
[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>ⓘ
[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]
fn poll_fill_buf(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<&[u8]>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<&[u8]>>
fn consume(self: Pin<&mut Self>, amt: usize)
[src]
impl<R: AsyncRead> AsyncRead for BufReader<R>
[src]
fn poll_read(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>
unsafe fn prepare_uninitialized_buffer(
&self,
buf: &mut [MaybeUninit<u8>]
) -> bool
[src]
&self,
buf: &mut [MaybeUninit<u8>]
) -> bool
fn poll_read_buf<B: BufMut>(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut B
) -> Poll<Result<usize>> where
Self: Sized,
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut B
) -> Poll<Result<usize>> where
Self: Sized,
impl<R: AsyncRead + AsyncWrite> AsyncWrite for BufReader<R>
[src]
fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
fn poll_write_buf<B: Buf>(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut B
) -> Poll<Result<usize>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut B
) -> Poll<Result<usize>>
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
[src]
fn poll_shutdown(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
[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]
__Origin<'__pin, R>: Unpin,
Auto Trait Implementations
impl<R> RefUnwindSafe for BufReader<R> where
R: RefUnwindSafe,
R: RefUnwindSafe,
impl<R> Send for BufReader<R> where
R: Send,
R: Send,
impl<R> Sync for BufReader<R> where
R: Sync,
R: Sync,
impl<R> UnwindSafe for BufReader<R> where
R: UnwindSafe,
R: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut Tⓘ
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,