From be62f065a62048b798e8bb2b8e3699bdd5b6d517 Mon Sep 17 00:00:00 2001 From: zirkonya Date: Tue, 1 Sep 2026 09:51:18 +0200 Subject: add proc macros ; benchmark ; example --- src/codec/encode.rs | 336 +++++++++++++++++++++++++++++----------------------- 1 file changed, 188 insertions(+), 148 deletions(-) (limited to 'src/codec/encode.rs') diff --git a/src/codec/encode.rs b/src/codec/encode.rs index 7463995..735aa70 100644 --- a/src/codec/encode.rs +++ b/src/codec/encode.rs @@ -1,49 +1,36 @@ -//! Encoding: writing protocol values into a byte stream. use crate::codec::error::Result; use crate::context::Context; -use std::{ - collections::{BTreeMap, BTreeSet, BinaryHeap, HashMap, HashSet, LinkedList, VecDeque}, - io::Write, -}; +use std::collections::{BTreeMap, BTreeSet, BinaryHeap, HashMap, HashSet, LinkedList, VecDeque}; macro_rules! impl_encode { - (u8) => { - impl Encode for u8 { - /// write number using big endian - fn encode(&self, buffer: &mut dyn Write, _: &Context) -> Result { - let size = buffer.write(&self.to_be_bytes())?; - Ok(size) + ($t:ty) => { + impl Encode for $t { + fn encode(&self, buffer: &mut Vec, _: &Context) -> Result { + buffer.extend_from_slice(&self.to_be_bytes()); + Ok(std::mem::size_of::<$t>()) } - /// write raw bytes - fn encode_slice( - slice: &[Self], - buffer: &mut dyn Write, - _: &Context, - ) -> Result { - buffer.write(slice).map_err(Into::into) - } - } - }; - ($t: ty) => { - impl Encode for $t { - /// write number using big endian - fn encode(&self, buffer: &mut dyn Write, _: &Context) -> Result { - let size = buffer.write(&self.to_be_bytes())?; - Ok(size) + fn encode_slice(slice: &[Self], buffer: &mut Vec, _: &Context) -> Result + where + Self: Sized, + { + let len = slice.len() * std::mem::size_of::<$t>(); + buffer.reserve(len); + for item in slice { + buffer.extend_from_slice(&item.to_be_bytes()); + } + Ok(len) } - fn encode_slice( - slice: &[Self], - buffer: &mut dyn Write, - _: &Context, - ) -> Result { - let len = buffer.write( - &slice - .iter() - .flat_map(|n| n.to_be_bytes()) - .collect::>(), - )?; + fn encode_iter<'a, I>(iter: I, buffer: &mut Vec, ctx: &Context) -> Result + where + Self: 'a + Sized, + I: IntoIterator, + { + let mut len = 0; + for item in iter { + len += item.encode(buffer, ctx)?; + } Ok(len) } } @@ -57,7 +44,7 @@ macro_rules! impl_encode_tuples { $($generic: Encode),+ { #[allow(non_snake_case)] - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { let ($($generic,)+): &($($generic,)+) = self; let mut len = 0; $(len += $generic.encode(buffer, ctx)?;)+ @@ -67,10 +54,11 @@ macro_rules! impl_encode_tuples { }; } -/// Write a value into a byte stream +/// Zero-copy encoding: writes directly into a byte buffer pub trait Encode { - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result; - fn encode_slice(slice: &[Self], buffer: &mut dyn Write, ctx: &Context) -> Result + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result; + + fn encode_slice(slice: &[Self], buffer: &mut Vec, ctx: &Context) -> Result where Self: Sized, { @@ -80,204 +68,257 @@ pub trait Encode { } Ok(len) } + + fn encode_iter<'a, I>(iter: I, buffer: &mut Vec, ctx: &Context) -> Result + where + Self: 'a + Sized, + I: IntoIterator, + { + let mut len = 0; + for item in iter { + len += item.encode(buffer, ctx)?; + } + Ok(len) + } } -// ~ Encode arrays +// ── Encode arrays ─────────────────────────────────────────────────────── impl> Encode for Vec { - /// Encode each element of Vec - /// use `CountPrefix` to prefix the vector with number of elements - /// use `LenPrefix` to prefix the vector with encoded byte size - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { T::encode_slice(self, buffer, ctx) } } impl> Encode for VecDeque { - /// Encode each element of VecDeque - /// use `CountPrefix` to prefix the VecDeque with number of elements - /// use `LenPrefix` to prefix the VecDeque with encoded byte size - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { - let (front, _) = self.as_slices(); - T::encode_slice(front, buffer, ctx) + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + let (front, back) = self.as_slices(); + let mut len = 0; + len += T::encode_slice(front, buffer, ctx)?; + len += T::encode_slice(back, buffer, ctx)?; + Ok(len) } } -impl> Encode for LinkedList -where - T: Clone, -{ - /// Encode each element of LinkedList (use clone..) - /// use `CountPrefix` to prefix the LinkedList with number of elements - /// use `LenPrefix` to prefix the LinkedList with encoded byte size - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { - let mut view = Vec::with_capacity(self.len()); - view.extend(self.iter().cloned()); - T::encode_slice(&view, buffer, ctx) +impl> Encode for LinkedList { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + let mut len = 0; + for item in self { + len += item.encode(buffer, ctx)?; + } + Ok(len) } } -// ~ Encode slices +// ── Encode slices ─────────────────────────────────────────────────────── impl> Encode for &[T] { - /// Encode each element of slice (use clone..) - /// use `CountPrefix` to prefix the slice with number of elements - /// use `LenPrefix` to prefix the slice with encoded byte size - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { T::encode_slice(self, buffer, ctx) } } impl, const S: usize> Encode for [T; S] { - /// Encode each element of slice (use clone..) - /// use `CountPrefix` to prefix the slice with number of elements - /// use `LenPrefix` to prefix the slice with encoded byte size - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { T::encode_slice(self, buffer, ctx) } } impl> Encode for [T] { - /// Encode each element of slice (use clone..) - /// use `CountPrefix` to prefix the slice with number of elements - /// use `LenPrefix` to prefix the slice with encoded byte size - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + T::encode_slice(self, buffer, ctx) + } +} + +// ── Encode references to collections ──────────────────────────────────── + +impl> Encode for &Vec { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { T::encode_slice(self, buffer, ctx) } } -// ~ Encode set +impl> Encode for &VecDeque { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + let (front, back) = self.as_slices(); + let mut len = 0; + len += T::encode_slice(front, buffer, ctx)?; + len += T::encode_slice(back, buffer, ctx)?; + Ok(len) + } +} -impl> Encode for HashSet +impl> Encode for &LinkedList { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + let mut len = 0; + for item in (*self).iter() { + len += item.encode(buffer, ctx)?; + } + Ok(len) + } +} + +impl> Encode for &HashSet { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + T::encode_iter(self.iter(), buffer, ctx) + } +} + +impl> Encode for &BTreeSet { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + T::encode_iter(self.iter(), buffer, ctx) + } +} + +impl> Encode for &BinaryHeap { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + T::encode_slice(self.as_slice(), buffer, ctx) + } +} + +impl Encode for &HashMap where - T: Clone, + K: Encode, + V: Encode, { - /// Encode each element of HashSet (use clone..) - /// use `CountPrefix` to prefix the HashSet with number of elements - /// use `LenPrefix` to prefix the HashSet with encoded byte size - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { - let mut view = Vec::with_capacity(self.len()); - view.extend(self.iter().cloned()); - T::encode_slice(&view, buffer, ctx) + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + let mut len = 0; + for (k, v) in (*self).iter() { + len += k.encode(buffer, ctx)?; + len += v.encode(buffer, ctx)?; + } + Ok(len) } } -impl> Encode for BTreeSet +impl Encode for &BTreeMap where - T: Clone, + K: Encode, + V: Encode, { - /// Encode each element of BTreeSet (use clone..) - /// use `CountPrefix` to prefix the BTreeSet with number of elements - /// use `LenPrefix` to prefix the BTreeSet with encoded byte size - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { - let mut view = Vec::with_capacity(self.len()); - view.extend(self.iter().cloned()); - T::encode_slice(&view, buffer, ctx) + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + let mut len = 0; + for (k, v) in (*self).iter() { + len += k.encode(buffer, ctx)?; + len += v.encode(buffer, ctx)?; + } + Ok(len) } } -// ~ Encode misc +// ── Encode set (owned) ────────────────────────────────────────────────── + +impl> Encode for HashSet { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + T::encode_iter(self.iter(), buffer, ctx) + } +} + +impl> Encode for BTreeSet { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + T::encode_iter(self.iter(), buffer, ctx) + } +} + +// ── Encode misc ───────────────────────────────────────────────────────── impl Encode for BinaryHeap where T: Encode, { - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { T::encode_slice(self.as_slice(), buffer, ctx) } } -// ~ Encode maps +// ── Encode maps (owned) ───────────────────────────────────────────────── impl Encode for HashMap where - K: Encode + Clone, - V: Encode + Clone, + K: Encode, + V: Encode, { - /// Encode each element of HashMap (use clone..) - /// use `CountPrefix` to prefix the HashMap with number of pairs - /// use `LenPrefix` to prefix the HashMap with encoded byte size - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { - let slice: Vec<(K, V)> = self.clone().into_iter().collect(); - <(K, V) as Encode>::encode_slice(&slice, buffer, ctx) + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + let mut len = 0; + for (k, v) in self { + len += k.encode(buffer, ctx)?; + len += v.encode(buffer, ctx)?; + } + Ok(len) } } impl Encode for BTreeMap where - K: Encode + Clone, - V: Encode + Clone, + K: Encode, + V: Encode, { - /// Encode each element of BTreeMap (use clone..) - /// use `CountPrefix` to prefix the BTreeMap with number of pairs - /// use `LenPrefix` to prefix the BTreeMap with encoded byte size - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { - let slice: Vec<(K, V)> = self.clone().into_iter().collect(); - <(K, V) as Encode>::encode_slice(&slice, buffer, ctx) + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + let mut len = 0; + for (k, v) in self { + len += k.encode(buffer, ctx)?; + len += v.encode(buffer, ctx)?; + } + Ok(len) } } -// ~ Encode string +// ── Encode string ─────────────────────────────────────────────────────── + impl Encode for String { - /// Encode the string using utf8 - /// use `CountPrefix` to prefix the string with char length - /// use `LenPrefix` to prefix the string with utf8 bytes length - fn encode(&self, buffer: &mut dyn Write, _: &Context) -> Result { + fn encode(&self, buffer: &mut Vec, _: &Context) -> Result { let utf8 = self.as_bytes(); - buffer.write_all(utf8)?; + buffer.extend_from_slice(utf8); Ok(utf8.len()) } } impl Encode for &str { - /// Encode the string using utf8 - /// use `CountPrefix` to prefix the string with char length - /// use `LenPrefix` to prefix the string with utf8 bytes length - fn encode(&self, buffer: &mut dyn Write, _: &Context) -> Result { + fn encode(&self, buffer: &mut Vec, _: &Context) -> Result { let utf8 = self.as_bytes(); - buffer.write_all(utf8)?; + buffer.extend_from_slice(utf8); Ok(utf8.len()) } } impl> Encode for Option { - /// Encode `T` if Some(T) or do nothing if None - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { match self { - Some(val) => { - let size = val.encode(buffer, ctx)?; - Ok(size) - } + Some(val) => val.encode(buffer, ctx), None => Ok(0), } } } -// ~ Encode primitive +// ── Encode primitive ──────────────────────────────────────────────────── + impl Encode for bool { - fn encode(&self, buffer: &mut dyn Write, _: &Context) -> Result { - let size = buffer.write(&[*self as u8])?; - Ok(size) + fn encode(&self, buffer: &mut Vec, _: &Context) -> Result { + buffer.push(*self as u8); + Ok(1) } - fn encode_slice(slice: &[Self], buffer: &mut dyn Write, _: &Context) -> Result + fn encode_slice(slice: &[Self], buffer: &mut Vec, _: &Context) -> Result where Self: Sized, { - let len = buffer.write(&slice.iter().map(|n| *n as u8).collect::>())?; + let len = slice.len(); + buffer.reserve(len); + for &b in slice { + buffer.push(b as u8); + } Ok(len) } } -// ~ Encode pointer +// ── Encode pointer ────────────────────────────────────────────────────── impl Encode for std::sync::Arc where T: Encode, { - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { - let data = self.as_ref(); - data.encode(buffer, ctx) + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + self.as_ref().encode(buffer, ctx) } } @@ -285,9 +326,8 @@ impl Encode for std::sync::Arc<[T]> where T: Encode, { - fn encode(&self, buffer: &mut dyn Write, ctx: &Context) -> Result { - let data = self.as_ref(); - data.encode(buffer, ctx) + fn encode(&self, buffer: &mut Vec, ctx: &Context) -> Result { + self.as_ref().encode(buffer, ctx) } } @@ -312,14 +352,14 @@ impl_encode!(f64); #[cfg(feature = "f128")] impl_encode!(f128); -// ~ Encode tuple +// ── Encode tuple ──────────────────────────────────────────────────────── impl Encode for () { - fn encode(&self, _: &mut dyn Write, _: &Context) -> Result { + fn encode(&self, _: &mut Vec, _: &Context) -> Result { Ok(0) } - fn encode_slice(_: &[Self], _: &mut dyn Write, _: &Context) -> Result + fn encode_slice(_: &[Self], _: &mut Vec, _: &Context) -> Result where Self: Sized, { -- cgit v1.2.3