msg_tool\utils/
struct_pack.rs

1//! Binary Struct Packing and Unpacking Utilities
2use crate::types::Encoding;
3use anyhow::Result;
4use msg_tool_macro::struct_unpack_impl_for_num;
5use std::io::{Read, Seek, Write};
6
7/// Trait for unpacking a struct from a binary stream.
8pub trait StructUnpack: Sized {
9    /// Unpacks a struct from a binary stream.
10    ///
11    /// * `reader` - The reader to read the binary data from.
12    /// * `big` - Whether the data is in big-endian format.
13    /// * `encoding` - The encoding to use for string fields.
14    fn unpack<R: Read + Seek>(reader: R, big: bool, encoding: Encoding) -> Result<Self>;
15}
16
17/// Trait for packing a struct into a binary stream.
18pub trait StructPack: Sized {
19    /// Packs a struct into a binary stream.
20    ///
21    /// * `writer` - The writer to write the binary data to.
22    /// * `big` - Whether to use big-endian format.
23    /// * `encoding` - The encoding to use for string fields.
24    fn pack<W: Write>(&self, writer: &mut W, big: bool, encoding: Encoding) -> Result<()>;
25}
26
27impl<T: StructPack> StructPack for Vec<T> {
28    fn pack<W: Write>(&self, writer: &mut W, big: bool, encoding: Encoding) -> Result<()> {
29        for item in self {
30            item.pack(writer, big, encoding)?;
31        }
32        Ok(())
33    }
34}
35
36struct_unpack_impl_for_num!(u8);
37struct_unpack_impl_for_num!(u16);
38struct_unpack_impl_for_num!(u32);
39struct_unpack_impl_for_num!(u64);
40struct_unpack_impl_for_num!(u128);
41struct_unpack_impl_for_num!(i8);
42struct_unpack_impl_for_num!(i16);
43struct_unpack_impl_for_num!(i32);
44struct_unpack_impl_for_num!(i64);
45struct_unpack_impl_for_num!(i128);
46struct_unpack_impl_for_num!(f32);
47struct_unpack_impl_for_num!(f64);
48
49impl StructUnpack for bool {
50    fn unpack<R: Read + Seek>(mut reader: R, _big: bool, _encoding: Encoding) -> Result<Self> {
51        let mut buf = [0u8; 1];
52        reader.read_exact(&mut buf)?;
53        Ok(buf[0] != 0)
54    }
55}
56
57impl StructPack for bool {
58    fn pack<W: Write>(&self, writer: &mut W, _big: bool, _encoding: Encoding) -> Result<()> {
59        writer.write_all(&[if *self { 1 } else { 0 }])?;
60        Ok(())
61    }
62}
63
64impl<T: StructPack> StructPack for Option<T> {
65    fn pack<W: Write>(&self, writer: &mut W, big: bool, encoding: Encoding) -> Result<()> {
66        if let Some(value) = self {
67            value.pack(writer, big, encoding)?;
68        }
69        Ok(())
70    }
71}
72
73impl<T: StructUnpack> StructUnpack for Option<T> {
74    fn unpack<R: Read + Seek>(reader: R, big: bool, encoding: Encoding) -> Result<Self> {
75        let value = T::unpack(reader, big, encoding)?;
76        Ok(Some(value))
77    }
78}
msg_tool\utils/struct_pack.rs

msg_tool\utils/
struct_pack.rs
