Struct futures_lite::io::BufWriter

source ·
pub struct BufWriter<W> { /* private fields */ }
Expand description

Adds buffering to a writer.

It can be excessively inefficient to work directly with something that implements AsyncWrite. For example, every call to write() on a TCP stream results in a system call. A BufWriter keeps an in-memory buffer of data and writes it to the underlying writer in large, infrequent batches.

BufWriter can improve the speed of programs that make small and repeated writes to the same file or networking socket. It does not help when writing very large amounts at once, or writing just once or a few times. It also provides no advantage when writing to a destination that is in memory, like a Vec<u8>.

Unlike std::io::BufWriter, this type does not write out the contents of its buffer when it is dropped. Therefore, it is important that users explicitly flush the buffer before dropping the BufWriter.

§Examples

use futures_lite::io::{AsyncWriteExt, BufWriter};

let mut output = Vec::new();
let mut writer = BufWriter::new(&mut output);

writer.write_all(b"hello").await?;
writer.flush().await?;

Implementations§

source§

impl<W: AsyncWrite> BufWriter<W>

source

pub fn new(inner: W) -> BufWriter<W>

Creates a buffered writer with the default buffer capacity.

The default capacity is currently 8 KB, but that may change in the future.

§Examples
use futures_lite::io::BufWriter;

let mut output = Vec::new();
let writer = BufWriter::new(&mut output);
source

pub fn with_capacity(capacity: usize, inner: W) -> BufWriter<W>

Creates a buffered writer with the specified buffer capacity.

§Examples
use futures_lite::io::BufWriter;

let mut output = Vec::new();
let writer = BufWriter::with_capacity(100, &mut output);
source

pub fn get_ref(&self) -> &W

Gets a reference to the underlying writer.

§Examples
use futures_lite::io::BufWriter;

let mut output = Vec::new();
let writer = BufWriter::new(&mut output);

let r = writer.get_ref();
source

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

Gets a mutable reference to the underlying writer.

It is not advisable to directly write to the underlying writer.

§Examples
use futures_lite::io::BufWriter;

let mut output = Vec::new();
let mut writer = BufWriter::new(&mut output);

let r = writer.get_mut();
source

pub fn into_inner(self) -> W

Unwraps the buffered writer, returning the underlying writer.

Note that any leftover data in the internal buffer will be lost. If you don’t want to lose that data, flush the buffered writer before unwrapping it.

§Examples
use futures_lite::io::{AsyncWriteExt, BufWriter};

let mut output = vec![1, 2, 3];
let mut writer = BufWriter::new(&mut output);

writer.write_all(&[4]).await?;
writer.flush().await?;
assert_eq!(writer.into_inner(), &[1, 2, 3, 4]);
source

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

Returns a reference to the internal buffer.

§Examples
use futures_lite::io::BufWriter;

let mut output = Vec::new();
let writer = BufWriter::new(&mut output);

// The internal buffer is empty until the first write request.
assert_eq!(writer.buffer(), &[]);

Trait Implementations§

source§

impl<W: AsyncWrite + AsyncSeek> AsyncSeek for BufWriter<W>

source§

fn poll_seek( self: Pin<&mut Self>, cx: &mut Context<'_>, pos: SeekFrom, ) -> Poll<Result<u64>>

Seek to the offset, in bytes, in the underlying writer.

Seeking always writes out the internal buffer before seeking.

source§

impl<W: AsyncWrite> AsyncWrite for BufWriter<W>

source§

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

Attempt to write bytes from buf into the object. Read more
source§

fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination. Read more
source§

fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>

Attempt to close the object. Read more
source§

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

Attempt to write bytes from bufs into the object using vectored IO operations. Read more
source§

impl<W: Debug> Debug for BufWriter<W>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'__pin, W> Unpin for BufWriter<W>
where __Origin<'__pin, W>: Unpin,

Auto Trait Implementations§

§

impl<W> Freeze for BufWriter<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for BufWriter<W>
where W: RefUnwindSafe,

§

impl<W> Send for BufWriter<W>
where W: Send,

§

impl<W> Sync for BufWriter<W>
where W: Sync,

§

impl<W> UnwindSafe for BufWriter<W>
where W: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<S> AsyncSeekExt for S
where S: AsyncSeek + ?Sized,

source§

fn seek(&mut self, pos: SeekFrom) -> SeekFuture<'_, Self>
where Self: Unpin,

Seeks to a new position in a byte stream. Read more
source§

impl<W> AsyncWriteExt for W
where W: AsyncWrite + ?Sized,

source§

fn write<'a>(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self>
where Self: Unpin,

Writes some bytes into the byte stream. Read more
source§

fn write_vectored<'a>( &'a mut self, bufs: &'a [IoSlice<'a>], ) -> WriteVectoredFuture<'a, Self>
where Self: Unpin,

Like write(), except that it writes a slice of buffers. Read more
source§

fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self>
where Self: Unpin,

Writes an entire buffer into the byte stream. Read more
source§

fn flush(&mut self) -> FlushFuture<'_, Self>
where Self: Unpin,

Flushes the stream to ensure that all buffered contents reach their destination. Read more
source§

fn close(&mut self) -> CloseFuture<'_, Self>
where Self: Unpin,

Closes the writer. Read more
source§

fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + Send + 'a>>
where Self: Sized + Send + 'a,

Boxes the writer and changes its type to dyn AsyncWrite + Send + 'a. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.