Struct Reader 

pub struct Reader<'a> { /* private fields */ }

A zero-allocation reader for the communication channel.

The Reader provides methods to read primitive values and arrays from a shared memory buffer. It maintains proper alignment for different data types and tracks the current offset position.

Examples

let mut storage = vec![0u64; 1024];
let mut reader = Reader::from(&mut storage);

let value = reader.read_u32();
let pi = reader.read_f64();

let array = reader.read_array_i32();

Implementations

impl<'a> Reader<'a>

pub fn from(storage: &'a mut [u64]) -> Self

Creates a new Reader from a mutable slice of u64 storage.

The storage must be 8-byte aligned and will be reinterpreted as different primitive types as needed.

Arguments

• storage - A mutable slice of u64 values to use as the backing buffer

Returns

A new Reader instance ready to read data.

pub fn reset(&mut self)

Resets the reader to the beginning of the buffer.

This allows reusing the same buffer for multiple read operations.

pub fn read_u8(&self) -> u8

Reads a u8 value from the channel.

Returns

The u8 value read from the channel.

Panics

Panics if the channel buffer would overflow.

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

Reads a u8 array from the channel with length prefix.

First reads the array length as u32, then reads that many elements.

Returns

A slice of u8 values.

Panics

Panics if the channel buffer would overflow.

pub fn read_elements_u8(&self, length: u32) -> &[u8]

Reads u8 array elements from the channel without length prefix.

Arguments

• length - The number of elements to read

Returns

A slice of u8 values.

Panics

Panics if the channel buffer would overflow.

pub fn read_u32(&self) -> u32

Reads a u32 value from the channel.

Returns

The u32 value read from the channel.

Panics

Panics if the channel buffer would overflow.

pub fn read_array_u32(&self) -> &[u32]

Reads a u32 array from the channel with length prefix.

First reads the array length as u32, then reads that many elements.

Returns

A slice of u32 values.

Panics

Panics if the channel buffer would overflow.

pub fn read_elements_u32(&self, length: u32) -> &[u32]

Reads u32 array elements from the channel without length prefix.

Arguments

• length - The number of elements to read

Returns

A slice of u32 values.

Panics

Panics if the channel buffer would overflow.

pub fn read_i32(&self) -> i32

Reads a i32 value from the channel.

Returns

The i32 value read from the channel.

Panics

Panics if the channel buffer would overflow.

pub fn read_array_i32(&self) -> &[i32]

Reads a i32 array from the channel with length prefix.

First reads the array length as u32, then reads that many elements.

Returns

A slice of i32 values.

Panics

Panics if the channel buffer would overflow.

pub fn read_elements_i32(&self, length: u32) -> &[i32]

Reads i32 array elements from the channel without length prefix.

Arguments

• length - The number of elements to read

Returns

A slice of i32 values.

Panics

Panics if the channel buffer would overflow.

pub fn read_f32(&self) -> f32

Reads a f32 value from the channel.

Returns

The f32 value read from the channel.

Panics

Panics if the channel buffer would overflow.

pub fn read_array_f32(&self) -> &[f32]

Reads a f32 array from the channel with length prefix.

First reads the array length as u32, then reads that many elements.

Returns

A slice of f32 values.

Panics

Panics if the channel buffer would overflow.

pub fn read_elements_f32(&self, length: u32) -> &[f32]

Reads f32 array elements from the channel without length prefix.

Arguments

• length - The number of elements to read

Returns

A slice of f32 values.

Panics

Panics if the channel buffer would overflow.

pub fn read_f64(&self) -> f64

Reads a f64 value from the channel.

Returns

The f64 value read from the channel.

Panics

Panics if the channel buffer would overflow.

pub fn read_array_f64(&self) -> &[f64]

Reads a f64 array from the channel with length prefix.

First reads the array length as u32, then reads that many elements.

Returns

A slice of f64 values.

Panics

Panics if the channel buffer would overflow.

pub fn read_elements_f64(&self, length: u32) -> &[f64]

Reads f64 array elements from the channel without length prefix.

Arguments

• length - The number of elements to read

Returns

A slice of f64 values.

Panics

Panics if the channel buffer would overflow.