Skip to main content

Encoder

Struct Encoder 

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

Streaming compressor implementing std::io::Write.

Writes are forwarded through a CStream and the resulting ZXC frame is flushed to the inner writer. The frame is finalised (residual block, EOF marker, and footer) by Encoder::finish. Drop performs a best-effort finish but cannot surface errors — prefer Encoder::finish when error handling matters.

Encoder is single-threaded; one stream per writer.

§Example

use std::io::Write;
use zxc::Encoder;

let sink = Vec::new();
let mut enc = Encoder::new(sink).unwrap();
enc.write_all(b"hello world").unwrap();
let compressed: Vec<u8> = enc.finish().unwrap();

Implementations§

Source§

impl<W: Write> Encoder<W>

Source

pub fn new(writer: W) -> Result<Self, Error>

Creates an encoder with default compression options: no checksum.

Source

pub fn with_options( writer: W, opts: Option<&CompressOptions>, ) -> Result<Self, Error>

Creates an encoder honouring opts. opts.seekable is ignored (push API is single-threaded and never emits a seek table).

Source

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

Finalises the frame, drains the inner writer, and returns it.

After this call the encoder is consumed; no further writes are possible.

Source

pub fn get_ref(&self) -> &W

Returns a reference to the underlying writer.

Source

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

Returns a mutable reference to the underlying writer.

Trait Implementations§

Source§

impl<W: Write> Drop for Encoder<W>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl<W: Write> Write for Encoder<W>

Source§

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

Flush is a no-op on the inner writer side: the ZXC frame is only valid once finalised, so partial flushes would produce a corrupted frame. Use Encoder::finish to complete the frame.

Source§

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

Writes a buffer into this writer, returning how many bytes were written. 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> !Sync for Encoder<W>

§

impl<W> Forget for Encoder<W>

§

impl<W> Freeze for Encoder<W>
where Option<W>: Freeze,

§

impl<W> Move for Encoder<W>

§

impl<W> RefUnwindSafe for Encoder<W>

§

impl<W> Send for Encoder<W>
where Option<W>: Send,

§

impl<W> Unpin for Encoder<W>
where Option<W>: Unpin,

§

impl<W> UnsafeUnpin for Encoder<W>
where Option<W>: UnsafeUnpin,

§

impl<W> UnwindSafe for Encoder<W>
where Option<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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.