Struct futures::io::BufWriter

pub struct BufWriter<W> { /* fields omitted */ }

Wraps a writer and buffers its output.

It can be excessively inefficient to work directly with something that implements AsyncWrite. A BufWriter keeps an in-memory buffer of data and writes it to an underlying writer in large, infrequent batches.

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

When the BufWriter is dropped, the contents of its buffer will be discarded. Creating multiple instances of a BufWriter on the same stream can cause data loss. If you need to write out the contents of its buffer, you must manually call flush before the writer is dropped.

Methods

impl<W> BufWriter<W> where
    W: AsyncWrite, 

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

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

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

Creates a new BufWriter with the specified buffer capacity.

Important traits for &'_ mut F

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

pub fn get_ref(&self) -> &W

Gets a reference to the underlying writer.

Important traits for &'_ mut F

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

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

Gets a mutable reference to the underlying writer.

It is inadvisable to directly write to the underlying writer.

Important 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;

pub fn get_pin_mut(self: Pin<&mut BufWriter<W>>) -> Pin<&mut W>

Gets a pinned mutable reference to the underlying writer.

It is inadvisable to directly write to the underlying writer.

pub fn into_inner(self) -> W

Consumes this BufWriter, returning the underlying writer.

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

Important traits for &'_ mut [u8]

impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

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

Returns a reference to the internally buffered data.

Trait Implementations

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

fn poll_seek(
    self: Pin<&mut BufWriter<W>>,
    cx: &mut Context,
    pos: SeekFrom
) -> Poll<Result<u64, Error>>

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

Seeking always writes out the internal buffer before seeking.

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

fn poll_write(
    self: Pin<&mut BufWriter<W>>,
    cx: &mut Context,
    buf: &[u8]
) -> Poll<Result<usize, Error>>

Attempt to write bytes from buf into the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

fn poll_flush(
    self: Pin<&mut BufWriter<W>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close(
    self: Pin<&mut BufWriter<W>>,
    cx: &mut Context
) -> Poll<Result<(), Error>>

Attempt to close the object.

impl<W> Debug for BufWriter<W> where
    W: Debug + AsyncWrite, 

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

Formats the value using the given formatter.