StreamingEncoder

Struct StreamingEncoder 

Source
pub struct StreamingEncoder<'a, W: Write> { /* private fields */ }
Expand description

Streaming encoder for processing large amounts of data efficiently.

Processes data in chunks to avoid loading entire files into memory. Suitable for encoding large files or network streams. Supports optional compression and hashing during encoding.

Implementations§

Source§

impl<'a, W: Write> StreamingEncoder<'a, W>

Source

pub fn new(dictionary: &'a Dictionary, writer: W) -> Self

Creates a new streaming encoder.

§Arguments
  • dictionary - The dictionary to use for encoding
  • writer - The destination for encoded output
Source

pub fn with_compression(self, algo: CompressionAlgorithm, level: u32) -> Self

Sets compression algorithm and level.

Source

pub fn with_hashing(self, algo: HashAlgorithm) -> Self

Sets hash algorithm for computing hash during encoding.

Source

pub fn with_xxhash_config(self, config: XxHashConfig) -> Self

Sets xxHash configuration (seed and secret).

Source

pub fn encode<R: Read>(&mut self, reader: &mut R) -> Result<Option<Vec<u8>>>

Encodes data from a reader in chunks.

Note: Radix mode requires reading the entire input at once due to the nature of true base conversion. For truly streaming behavior, use Chunked or ByteRange modes.

Returns the computed hash if hash_algo was set, otherwise None.

Auto Trait Implementations§

§

impl<'a, W> Freeze for StreamingEncoder<'a, W>
where W: Freeze,

§

impl<'a, W> RefUnwindSafe for StreamingEncoder<'a, W>
where W: RefUnwindSafe,

§

impl<'a, W> Send for StreamingEncoder<'a, W>
where W: Send,

§

impl<'a, W> Sync for StreamingEncoder<'a, W>
where W: Sync,

§

impl<'a, W> Unpin for StreamingEncoder<'a, W>
where W: Unpin,

§

impl<'a, W> UnwindSafe for StreamingEncoder<'a, 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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V