# Struct bytes::buf::Writer

source ·

    pub struct Writer<B> { /* private fields */ }

Expand description

A `BufMut` adapter which implements `io::Write` for the inner value.

This struct is generally created by calling `writer()` on `BufMut`. See documentation of `writer()` for more details.

## Implementations§

source §

### impl<B: BufMut> Writer<B>

source

#### pub fn get_ref(&self) -> &B

Gets a reference to the underlying `BufMut`.

It is inadvisable to directly write to the underlying `BufMut`.

##### §Examples

    use bytes::BufMut;

    let buf = Vec::with_capacity(1024).writer();

    assert_eq!(1024, buf.get_ref().capacity());

source

#### pub fn get_mut(&mut self) -> &mut B

Gets a mutable reference to the underlying `BufMut`.

It is inadvisable to directly write to the underlying `BufMut`.

##### §Examples

    use bytes::BufMut;

    let mut buf = vec![].writer();

    buf.get_mut().reserve(1024);

    assert_eq!(1024, buf.get_ref().capacity());

source

#### pub fn into_inner(self) -> B

Consumes this `Writer`, returning the underlying value.

##### §Examples

    use bytes::BufMut;
    use std::io;

    let mut buf = vec![].writer();
    let mut src = &b"hello world"[..];

    io::copy(&mut src, &mut buf).unwrap();

    let buf = buf.into_inner();
    assert_eq!(*buf, b"hello world"[..]);

## Trait Implementations§

source §

### impl<B: Debug> Debug for Writer<B>

source §

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

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

### impl<B: BufMut + Sized> Write for Writer<B>

source §

#### fn write(&mut self, src: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written. Read more
source §

#### fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · source §

#### fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

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

#### fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (`can_vector`)
Determines if this `Write`r has an efficient `write_vectored` implementation. Read more
1.0.0 · source §

#### fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer. Read more
source §

#### fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (`write_all_vectored`)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · source §

#### fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · source §

#### fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of `Write`. Read more

## Auto Trait Implementations§

§

### impl<B> Freeze for Writer<B>
where B: Freeze,

§

### impl<B> RefUnwindSafe for Writer<B>
where B: RefUnwindSafe,

§

### impl<B> Send for Writer<B>
where B: Send,

§

### impl<B> Sync for Writer<B>
where B: Sync,

§

### impl<B> Unpin for Writer<B>
where B: Unpin,

§

### impl<B> UnwindSafe for Writer<B>
where B: 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<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>,

source §

#### 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>,

source §

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