Struct FrameEncoder 

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

Snappy framed format encoder.

Wraps a writer and compresses data written to it using the Snappy framed format. Data is buffered internally and flushed as complete chunks.

Example

use oxiarc_snappy::FrameEncoder;
use std::io::Write;

let mut compressed = Vec::new();
{
    let mut encoder = FrameEncoder::new(&mut compressed);
    encoder.write_all(b"Hello, World!").unwrap();
    encoder.finish().unwrap();
}

Implementations

impl<W: Write> FrameEncoder<W>

pub fn new(inner: W) -> Self

Create a new framed encoder wrapping the given writer.

The stream identifier chunk will be written on the first write call.

pub fn with_pool(inner: W, pool: &SnappyPool) -> Self

Create a new framed encoder that reuses scratch buffers from pool.

All other behaviour is identical to FrameEncoder::new.

pub fn with_progress(self, handle: ProgressHandle) -> Self

Attach a progress sink that will receive on_progress callbacks once per encoded chunk.

pub fn with_cancel(self, token: CancellationToken) -> Self

Attach a cancellation token. The token is checked before each chunk is written; if it has been cancelled the operation returns an I/O error with the message "operation cancelled".

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

Finish encoding and return the underlying writer.

This flushes any remaining buffered data as a final chunk.

Errors

Returns an I/O error if writing fails.

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

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.

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

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

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Like write, except that it writes from a slice of buffers.

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.

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

Attempts to write an entire buffer into this writer.

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.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

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