Struct zstd::stream::zio::Writer

source ·
pub struct Writer<W, D> { /* private fields */ }
Expand description

Implements the Write API around an Operation.

This can be used to wrap a raw in-memory operation in a write-focused API.

It can be used with either compression or decompression, and forwards the output to a wrapped Write.

Implementations§

source§

impl<W, D> Writer<W, D>
where W: Write, D: Operation,

source

pub fn new(writer: W, operation: D) -> Self

Creates a new Writer.

All output from the given operation will be forwarded to writer.

source

pub fn finish(&mut self) -> Result<()>

Ends the stream.

This must be called after all data has been written to finish the stream.

If you forget to call this and just drop the Writer, you will have an incomplete output.

Keep calling it until it returns Ok(()), then don’t call it again.

source

pub fn into_inner(self) -> (W, D)

Return the wrapped Writer and Operation.

Careful: if you call this before calling Writer::finish(), the output may be incomplete.

source

pub fn writer(&self) -> &W

Gives a reference to the inner writer.

source

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

Gives a mutable reference to the inner writer.

source

pub fn operation(&self) -> &D

Gives a reference to the inner operation.

source

pub fn operation_mut(&mut self) -> &mut D

Gives a mutable reference to the inner operation.

Trait Implementations§

source§

impl<W, D> Write for Writer<W, D>
where W: Write, D: Operation,

source§

fn write(&mut self, buf: &[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 Writer 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<W, D> Freeze for Writer<W, D>
where W: Freeze, D: Freeze,

§

impl<W, D> RefUnwindSafe for Writer<W, D>

§

impl<W, D> Send for Writer<W, D>
where W: Send, D: Send,

§

impl<W, D> Sync for Writer<W, D>
where W: Sync, D: Sync,

§

impl<W, D> Unpin for Writer<W, D>
where W: Unpin, D: Unpin,

§

impl<W, D> UnwindSafe for Writer<W, D>
where W: UnwindSafe, D: 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>,

§

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.