Struct BinaryEncoder 

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

Binary encoder with versioning support

Implementations

impl<W: Write> BinaryEncoder<W>

pub fn new(writer: W) -> Self

Create a new encoder with the current protocol version

pub fn with_version(writer: W, version: u8) -> Self

Create an encoder with a specific protocol version

pub fn write_header(&mut self) -> ChieResult<()>

Write the message header (magic bytes + version)

Errors

Returns error if writing fails

pub fn write_u8(&mut self, value: u8) -> ChieResult<()>

Write a u8 value

Errors

Returns error if writing fails

pub fn write_u32(&mut self, value: u32) -> ChieResult<()>

Write a u32 value (little-endian)

Errors

Returns error if writing fails

pub fn write_u64(&mut self, value: u64) -> ChieResult<()>

Write a u64 value (little-endian)

Errors

Returns error if writing fails

pub fn write_bytes(&mut self, bytes: &[u8]) -> ChieResult<()>

Write a variable-length byte array (length prefix + data)

Errors

Returns error if writing fails

pub fn write_string(&mut self, s: &str) -> ChieResult<()>

Write a string (UTF-8 encoded with length prefix)

Errors

Returns error if writing fails

pub fn write_bool(&mut self, value: bool) -> ChieResult<()>

Write a boolean as a single byte

Errors

Returns error if writing fails

pub fn write_checksum(&mut self, data: &[u8]) -> ChieResult<()>

Write a CRC32 checksum for the given data

Errors

Returns error if writing fails

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

Get a mutable reference to the underlying writer

pub fn into_inner(self) -> W

Consume the encoder and return the underlying writer

pub fn write_bytes_chunked<R: Read>( &mut self, reader: &mut R, total_size: u64, chunk_size: usize, ) -> ChieResult<()>

Write large byte array in chunks to avoid excessive memory allocation

Examples

use chie_shared::encoding::BinaryEncoder;

let data = vec![1u8; 10_000]; // 10KB of data
let mut reader = &data[..];
let mut buf = Vec::new();
let mut encoder = BinaryEncoder::new(&mut buf);

// Write in 1KB chunks
encoder.write_bytes_chunked(&mut reader, 10_000, 1024).unwrap();

Errors

Returns error if writing fails

pub fn copy_from_reader<R: Read>(&mut self, reader: &mut R) -> ChieResult<u64>

Stream data directly from a reader without buffering entire payload

Errors

Returns error if copying fails