Skip to main content

ByteSerializer

Struct ByteSerializer 

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

A serializer that writes data to a byte buffer in little-endian format.

This is a concrete implementation of the Serializer trait that writes binary data in a compact, little-endian format. This is the default serializer used by the crate::to_bytes convenience function.

§Format

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

§Examples

§Basic Usage

use osal_rs_serde::{ByteSerializer, Serializer, Serialize};

let mut buffer = [0u8; 16];
let mut serializer = ByteSerializer::new(&mut buffer);

serializer.serialize_u32("", 42).unwrap();
serializer.serialize_bool("", true).unwrap();
serializer.serialize_i16("", -100).unwrap();

let len = serializer.position();
println!("Serialized {} bytes", len);

§With Structs

use osal_rs_serde::{ByteSerializer, Serialize};

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

let msg = Message { id: 100, value: -50 };
let mut buffer = [0u8; 32];
let mut serializer = ByteSerializer::new(&mut buffer);
msg.serialize(&mut serializer).unwrap();

§Memory Layout

The serializer writes data sequentially without padding or alignment:

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

Implementations§

Source§

impl<'a> ByteSerializer<'a>

Source

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

Create a new ByteSerializer with the given buffer.

Source

pub fn position(&self) -> usize

Get the current position in the buffer.

Trait Implementations§

Source§

impl<'a> Serializer for ByteSerializer<'a>

Source§

fn serialize_array<T>(&mut self, name: &str, v: &[T]) -> Result<(), Self::Error>
where T: Serialize,

Serialize an array of serializable items.

Source§

type Error = Error

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

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

Serialize a bool value.
Source§

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

Serialize a u8 value.
Source§

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

Serialize an i8 value.
Source§

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

Serialize a u16 value.
Source§

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

Serialize an i16 value.
Source§

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

Serialize a u32 value.
Source§

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

Serialize an i32 value.
Source§

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

Serialize a u64 value.
Source§

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

Serialize an i64 value.
Source§

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

Serialize a u128 value.
Source§

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

Serialize an i128 value.
Source§

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

Serialize an f32 value.
Source§

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

Serialize an f64 value.
Source§

fn serialize_bytes(&mut self, _name: &str, v: &[u8]) -> Result<()>

Serialize a byte slice.
Source§

fn serialize_string( &mut self, name: &str, v: &String, ) -> Result<(), Self::Error>

Serialize a string.
Source§

fn serialize_str(&mut self, name: &str, v: &str) -> Result<(), Self::Error>

Serialize a string slice.
Source§

fn serialize_vec<T>( &mut self, name: &str, v: &Vec<T>, ) -> Result<(), Self::Error>
where T: Serialize,

Serialize a vector of serializable items.
Source§

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

Begin serializing a struct with the given name and number of fields. Default implementation does nothing (suitable for binary formats).
Source§

fn serialize_field<T>( &mut self, name: &str, value: &T, ) -> Result<(), Self::Error>
where T: Serialize,

Serialize a struct field with name and value. Default implementation just serializes the value.
Source§

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

End serializing a struct. Default implementation does nothing (suitable for binary formats).

Auto Trait Implementations§

§

impl<'a> Freeze for ByteSerializer<'a>

§

impl<'a> RefUnwindSafe for ByteSerializer<'a>

§

impl<'a> Send for ByteSerializer<'a>

§

impl<'a> Sync for ByteSerializer<'a>

§

impl<'a> Unpin for ByteSerializer<'a>

§

impl<'a> UnsafeUnpin for ByteSerializer<'a>

§

impl<'a> !UnwindSafe for ByteSerializer<'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.