Struct Encoder

Source

pub struct Encoder { /* private fields */ }

Expand description

Encoder for ALEC messages.

The encoder maintains internal state (sequence numbers) and provides methods to encode sensor data into compact binary messages.

§Thread Safety

Encoder is not thread-safe. Each thread should have its own instance. For multi-threaded scenarios, consider using separate encoders per thread or wrapping in a Mutex.

Implementations§

Source §

impl Encoder

Source

pub fn new() -> Self

Create a new encoder with default settings.

§Example

use alec::Encoder;

let encoder = Encoder::new();
assert_eq!(encoder.sequence(), 0);
assert!(!encoder.checksum_enabled());

Source

pub fn with_checksum() -> Self

Create an encoder with checksum verification enabled.

When checksum is enabled, encoded messages include a CRC32 checksum for integrity verification during decoding.

§Example

use alec::Encoder;

let encoder = Encoder::with_checksum();
assert!(encoder.checksum_enabled());

Source

pub fn checksum_enabled(&self) -> bool

Check if checksum is enabled for this encoder.

Source

pub fn sequence(&self) -> u16

Get the current sequence number.

Sequence numbers are used to detect message loss and ordering issues.

Source

pub fn reset_sequence(&mut self)

Reset the sequence number to zero.

Call this when establishing a new connection or after a sync reset.

Source

pub fn encode_to_bytes( &mut self, data: &RawData, classification: &Classification, context: &Context, ) -> Vec<u8> ⓘ

Encode data and return raw bytes.

This is a convenience method that combines encoding and serialization. If checksum is enabled, the returned bytes include the checksum.

§Arguments

data - The raw sensor data to encode
classification - Priority classification from the classifier
context - Shared context for predictions and patterns

§Returns

A Vec<u8> containing the encoded message bytes.

Source

pub fn encode_with_metrics( &mut self, data: &RawData, classification: &Classification, context: &Context, metrics: &mut CompressionMetrics, ) -> EncodedMessage

Encode data while collecting compression metrics.

Use this method to track compression performance over time.

§Arguments

data - The raw sensor data to encode
classification - Priority classification
context - Shared context
metrics - Metrics collector to update

§Returns

The encoded message.

Source

pub fn encode( &mut self, data: &RawData, classification: &Classification, context: &Context, ) -> EncodedMessage

Encode data with classification into a compact message.

This method selects the optimal encoding strategy based on the context’s predictions and the data’s characteristics:

If value equals the last value, uses repeated encoding (1 byte)
If value is close to prediction, uses delta encoding (1-4 bytes)
Otherwise, uses raw encoding (8 bytes for value)

§Arguments

data - The raw sensor data to encode
classification - Priority classification from the classifier
context - Shared context for predictions and patterns

§Returns

An EncodedMessage containing the compressed data.

§Examples

use alec::{Encoder, Classifier, Context, RawData};

let mut encoder = Encoder::new();
let classifier = Classifier::default();
let context = Context::new();

let data = RawData::new(22.5, 0);
let classification = classifier.classify(&data, &context);
let message = encoder.encode(&data, &classification, &context);

// Message is ready to transmit
println!("Encoded {} bytes", message.len());