Crate le_stream 

Little-endian byte stream encoding and decoding.

le-stream defines compact ToLeStream and FromLeStream traits for types that are represented as a sequence of little-endian bytes. The traits work directly on iterators, which keeps the crate usable in no_std environments and avoids requiring an intermediate buffer.

Primitive integer and floating-point types are encoded with their native to_le_bytes representation. Arrays, ranges, options, and feature-gated collection types are encoded by concatenating the representation of their contents. Option<T> is intentionally compact: None emits no bytes and Some(value) emits only value.

Collection Semantics

Standard-library collection types behind the alloc feature are not length-prefixed by default. Vec<T> and Box<[T]> deserialize by consuming as many complete T values as the byte stream can provide. Use Prefixed<P, D> when an allocated collection needs an explicit length in the stream.

heapless::Vec<T, N, LenT> and heapless::String<N, LenT> are different: they always encode a length prefix of type LenT, followed by exactly that many serialized elements or UTF-8 bytes. During deserialization the prefix is read first, and the implementation then attempts to consume exactly the number of elements or bytes described by that prefix. This works naturally for heapless collections because their type carries a fixed capacity limit.

The derive feature re-exports derive macros for structs and explicitly represented enums. Derived enums require #[repr(T)] and explicit discriminants on every variant; the discriminant is encoded as T, followed by any associated data.

Examples

use le_stream::{FromLeStream, ToLeStream};

let value = 0x1234_u16;
assert_eq!(value.to_le_stream().collect::<Vec<_>>(), [0x34, 0x12]);
assert_eq!(u16::from_le_stream([0x34, 0x12].into_iter()), Some(value));

With the derive feature enabled:

use le_stream::{FromLeStream, ToLeStream};

#[derive(Clone, Debug, Eq, PartialEq, FromLeStream, ToLeStream)]
struct Header {
    command: u8,
    sequence: u16,
}

let header = Header {
    command: 0xA5,
    sequence: 0x1234,
};

let bytes: Vec<_> = header.clone().to_le_stream().collect();
assert_eq!(bytes, [0xA5, 0x34, 0x12]);
assert_eq!(Header::from_le_stream_exact(bytes.into_iter()).unwrap(), header);

Structs

LeStreamIterator

Iterator adapter returned by LeStream::le_stream.

Prefixed

A wrapper that serializes a collection with a little-endian length prefix.

Enums

Error

Error type for byte stream operations.

Traits

Consume

Convenience trait for decoding a value from a byte iterator.

FromLeStream

Parses a value from a stream of little-endian bytes.

LeStream

Extension trait for reading typed values from an iterator of bytes.

ToLeStream

Converts a value into a stream of little-endian bytes.

TryFromLeStream

Try to parse an object from a stream of bytes with little endianness.

Type Aliases

Result

Result type with Error as error variant.