Skip to main content

FrameEncoder

Struct FrameEncoder 

Source
pub struct FrameEncoder<W: Write> { /* private fields */ }
Expand description

Streaming zstd compressor implementing Write.

Buffers input until a full block (128 KiB) is ready, then compresses and writes it to the underlying writer. Call finish to flush the final block, write the content checksum, and recover the writer.

use std::io::Write;

let mut encoder = zrip::FrameEncoder::new(Vec::new(), 1).unwrap();
encoder.write_all(b"streaming data").unwrap();
let compressed = encoder.finish().unwrap();
assert!(!compressed.is_empty());

Implementations§

Source§

impl<W: Write> FrameEncoder<W>

Source

pub fn new(writer: W, level: i32) -> Result<Self, CompressError>

Creates a new streaming encoder at the given level (-7..=4).

Source

pub fn finish(self) -> Result<W, Error>

Flushes remaining data, writes the content checksum, and returns the inner writer.

Trait Implementations§

Source§

impl<W: Write> Write for FrameEncoder<W>

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, args: 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> Freeze for FrameEncoder<W>
where W: Freeze,

§

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

§

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

§

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

§

impl<W> Unpin for FrameEncoder<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for FrameEncoder<W>
where W: UnsafeUnpin,

§

impl<W> UnwindSafe for FrameEncoder<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<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.