Skip to main content

ByteDeserializer

Struct ByteDeserializer 

Source
pub struct ByteDeserializer<'a> { /* private fields */ }
Expand description

A deserializer that reads data from a byte buffer in little-endian format.

This is a concrete implementation of the Deserializer trait that reads binary data in a compact, little-endian format. This is the default deserializer used by the crate::from_bytes convenience function.

§Format

This deserializer expects data in the same format as crate::ser::ByteSerializer:

  • All integers in little-endian byte order
  • Floating-point numbers in IEEE 754 representation
  • bool as a single byte (0 or 1)
  • Option<T>: 1 byte tag (0=None, 1=Some) followed by T if Some
  • Arrays: Elements deserialized sequentially (no length prefix expected)
  • Tuples: Elements deserialized sequentially
  • Strings/Vec: u32 length prefix followed by data

§Examples

§Basic Usage

use osal_rs_serde::{ByteDeserializer, Deserializer};

let buffer = [42u8, 0, 0, 0, 1, 156, 255];
let mut deserializer = ByteDeserializer::new(&buffer);

let value1 = deserializer.deserialize_u32("").unwrap();
let value2 = deserializer.deserialize_bool("").unwrap();
let value3 = deserializer.deserialize_i16("").unwrap();

assert_eq!(value1, 42);
assert_eq!(value2, true);
assert_eq!(value3, -100);

§With Structs

use osal_rs_serde::{ByteDeserializer, Deserialize, from_bytes};

#[derive(Deserialize)]
struct Message {
    id: u32,
    value: i16,
}

let buffer = [100, 0, 0, 0, 206, 255]; // id=100, value=-50 in little-endian
let msg: Message = from_bytes(&buffer).unwrap();

assert_eq!(msg.id, 100);
assert_eq!(msg.value, -50);

§Error Handling

Returns Error::UnexpectedEof if the buffer doesn’t contain enough data for the requested type.

§Memory Layout

The deserializer reads data sequentially without expecting padding or alignment:

struct Data { a: u16, b: u32 }
Memory: [a_lo, a_hi, b0, b1, b2, b3]

Implementations§

Source§

impl<'a> ByteDeserializer<'a>

Source

pub fn new(buffer: &'a [u8]) -> Self

Create a new ByteDeserializer with the given buffer.

Source

pub fn position(&self) -> usize

Get the current position in the buffer.

Trait Implementations§

Source§

impl<'a> Deserializer for ByteDeserializer<'a>

Source§

type Error = Error

The error type that can be returned during deserialization.
Source§

fn deserialize_bool(&mut self, _name: &str) -> Result<bool>

Deserialize a bool value.
Source§

fn deserialize_u8(&mut self, _name: &str) -> Result<u8>

Deserialize a u8 value.
Source§

fn deserialize_i8(&mut self, _name: &str) -> Result<i8>

Deserialize an i8 value.
Source§

fn deserialize_u16(&mut self, _name: &str) -> Result<u16>

Deserialize a u16 value.
Source§

fn deserialize_i16(&mut self, _name: &str) -> Result<i16>

Deserialize an i16 value.
Source§

fn deserialize_u32(&mut self, _name: &str) -> Result<u32>

Deserialize a u32 value.
Source§

fn deserialize_i32(&mut self, _name: &str) -> Result<i32>

Deserialize an i32 value.
Source§

fn deserialize_u64(&mut self, _name: &str) -> Result<u64>

Deserialize a u64 value.
Source§

fn deserialize_i64(&mut self, _name: &str) -> Result<i64>

Deserialize an i64 value.
Source§

fn deserialize_u128(&mut self, _name: &str) -> Result<u128>

Deserialize a u128 value.
Source§

fn deserialize_i128(&mut self, _name: &str) -> Result<i128>

Deserialize an i128 value.
Source§

fn deserialize_f32(&mut self, _name: &str) -> Result<f32>

Deserialize an f32 value.
Source§

fn deserialize_f64(&mut self, _name: &str) -> Result<f64>

Deserialize an f64 value.
Source§

fn deserialize_bytes(&mut self, _name: &str, buffer: &mut [u8]) -> Result<usize>

Deserialize bytes into a buffer. Returns the number of bytes read.
Source§

fn deserialize_string(&mut self, _name: &str) -> Result<String>

Deserialize a string.
Source§

fn deserialize_vec<T>(&mut self, _name: &str) -> Result<Vec<T>>
where T: Deserialize,

Deserialize a vector of deserializable items.
Source§

fn deserialize_array<T, const N: usize>( &mut self, _name: &str, ) -> Result<[T; N]>
where T: Deserialize,

Deserialize an array of deserializable items.
Source§

fn deserialize_struct_start(&mut self, _name: &str) -> Result<(), Self::Error>

Begin deserializing a struct with the given name.
Source§

fn deserialize_field<T>(&mut self, name: &str) -> Result<T, Self::Error>
where T: Deserialize,

Deserialize a struct field with name.
Source§

fn deserialize_struct_end(&mut self) -> Result<(), Self::Error>

End deserializing a struct.

Auto Trait Implementations§

§

impl<'a> Freeze for ByteDeserializer<'a>

§

impl<'a> RefUnwindSafe for ByteDeserializer<'a>

§

impl<'a> Send for ByteDeserializer<'a>

§

impl<'a> Sync for ByteDeserializer<'a>

§

impl<'a> Unpin for ByteDeserializer<'a>

§

impl<'a> UnsafeUnpin for ByteDeserializer<'a>

§

impl<'a> UnwindSafe for ByteDeserializer<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.