[][src]Struct futures_util::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: AsyncWrite> BufWriter<W>[src]

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

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) -> Self[src]

Creates a new BufWriter with the specified buffer capacity.

pub fn get_ref(&self) -> &W[src]

Gets a reference to the underlying writer.

pub fn get_mut(&mut self) -> &mut W[src]

Gets a mutable reference to the underlying writer.

It is inadvisable to directly write to the underlying writer.

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut W>[src]

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[src]

Consumes this BufWriter, returning the underlying writer.

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

Important traits for &'_ mut [u8]
pub fn buffer(&self) -> &[u8][src]

Returns a reference to the internally buffered data.

Trait Implementations

impl<W: AsyncWrite + Debug> Debug for BufWriter<W>[src]

impl<W: AsyncWrite> AsyncWrite for BufWriter<W>[src]

impl<W: AsyncWrite + AsyncSeek> AsyncSeek for BufWriter<W>[src]

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

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

Seeking always writes out the internal buffer before seeking.

Auto Trait Implementations

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

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

impl<W> Unpin for BufWriter<W> where
    W: Unpin

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

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

Blanket Implementations

impl<W> AsyncWriteExt for W where
    W: AsyncWrite + ?Sized
[src]

Important traits for Flush<'_, W>
fn flush(&mut self) -> Flush<Self> where
    Self: Unpin
[src]

Creates a future which will entirely flush this AsyncWrite. Read more

Important traits for Close<'_, W>
fn close(&mut self) -> Close<Self> where
    Self: Unpin
[src]

Creates a future which will entirely close this AsyncWrite.

Important traits for Write<'_, W>
fn write<'a>(&'a mut self, buf: &'a [u8]) -> Write<'a, Self> where
    Self: Unpin
[src]

Creates a future which will write bytes from buf into the object. Read more

Important traits for WriteVectored<'_, W>
fn write_vectored<'a>(
    &'a mut self,
    bufs: &'a [IoSlice<'a>]
) -> WriteVectored<'a, Self> where
    Self: Unpin
[src]

Creates a future which will write bytes from bufs into the object using vectored IO operations. Read more

Important traits for WriteAll<'_, W>
fn write_all<'a>(&'a mut self, buf: &'a [u8]) -> WriteAll<'a, Self> where
    Self: Unpin
[src]

Write data into this object. Read more

Important traits for Compat<R>
fn compat_write(self) -> Compat<Self> where
    Self: Sized + Unpin
[src]

Wraps an AsyncWrite in a compatibility wrapper that allows it to be used as a futures 0.1 / tokio-io 0.1 AsyncWrite. Requires the io-compat feature to enable. Read more

fn into_sink<Item: AsRef<[u8]>>(self) -> IntoSink<Self, Item> where
    Self: Sized
[src]

Allow using an AsyncWrite as a Sink``<Item: AsRef<[u8]>>. Read more

impl<S> AsyncSeekExt for S where
    S: AsyncSeek + ?Sized
[src]

Important traits for Seek<'_, S>
fn seek(&mut self, pos: SeekFrom) -> Seek<Self> where
    Self: Unpin
[src]

Creates a future which will seek an IO object, and then yield the new position in the object and the object itself. Read more

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.

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

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

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

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,