Struct svbyte::EncodeCursor

pub struct EncodeCursor<W> { /* private fields */ }

Stream VByte Encoder

Encodes a stream of numbers and saves them in a Write output stream.

Data format follows this structure:

┌───────┬───────┬─────────┬─────────┬────────┬────────┐
│ MAGIC │ COUNT │ CS SIZE │ DS SIZE │ CS ... │ DS ... │
└───────┴───────┴─────────┴─────────┴────────┴────────┘

• MAGIC is always 0x0B0D;
• COUNT the number of elements encoded in the segment (u32);
• CS SIZE is the size of control stream in bytes (u32);
• DS SIZE is the size of data stream in bytes (u32);
• CS and DS and control and data streams.

Segment header (MAGIC, COUNT, CS SIZE, DS SIZE) is enough to calculate the whole segment size. Segments follows each other until EOF of a stream reached.

Implementations

impl<W: Write> EncodeCursor<W>

pub fn new(output: W) -> Self

pub fn encode(&mut self, input: &[u32]) -> Result<()>

Compresses input data using stream algorithm

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

Finish pending writes

Write last segment to the output and return underlying Write to the client. Writes are not flushed. It is a responsibility of a client to flush if needed.