Struct Encoder 

pub struct Encoder { /* private fields */ }

Encoder that serializes Values into Crous binary format.

Example

use crous_core::{Encoder, Value};

let mut enc = Encoder::new();
enc.encode_value(&Value::UInt(42)).unwrap();
let bytes = enc.finish().unwrap();
assert!(bytes.len() > 8); // header + block

Implementations

impl Encoder

pub fn new() -> Self

Create a new encoder with default settings.

pub fn with_limits(limits: Limits) -> Self

Create an encoder with custom limits.

pub fn enable_dedup(&mut self)

Enable string deduplication. Repeated strings within a block will be encoded as Reference wire types pointing to the dictionary.

pub fn set_compression(&mut self, comp: CompressionType)

Set the compression type for subsequent blocks.

pub fn set_flags(&mut self, flags: u8)

Set the file header flags.

pub fn encode_value(&mut self, value: &Value) -> Result<()>

Encode a single Value into the current block buffer.

This is the main entry point for encoding. Values are accumulated in the block buffer; call finish() to flush and produce the final bytes.

pub fn flush_block(&mut self) -> Result<usize>

Flush the current block buffer into a framed block and append to output. Returns the number of bytes in the flushed block.

When dedup_strings is enabled and the per-block string dictionary is non-empty, a StringDict block is emitted before the data block. The dictionary entries are sorted and stored using prefix-delta compression for compactness.

When compression is set to something other than None, the block payload is compressed before framing. The checksum is always computed on the uncompressed payload so the decoder can verify integrity after decompression. The block_len field reflects the compressed size written to the wire.

pub fn finish(self) -> Result<Vec<u8>>

Finish encoding: flush remaining data and return the complete binary output.

The output includes: file header + data blocks + file trailer checksum.

pub fn current_size(&self) -> usize

Get the current size of the output buffer (including unflushed block data).

pub fn block_buffer(&self) -> &[u8]

Get access to the raw block buffer (for testing/inspection).

Trait Implementations

impl Default for Encoder

fn default() -> Self

Returns the “default value” for a type.