Skip to content

Implement serde for BoxedUint #789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ proptest = "1.5"
rand_core = { version = "0.9", features = ["std", "os_rng"] }
rand_chacha = "0.9"


[features]
default = ["rand"]
alloc = ["serdect?/alloc"]
Expand Down
3 changes: 3 additions & 0 deletions src/uint/boxed/encoding.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ use crate::{DecodeError, Limb, Word, uint::encoding};
use alloc::{boxed::Box, string::String, vec::Vec};
use subtle::{Choice, CtOption};

#[cfg(feature = "serde")]
mod serde;

impl BoxedUint {
/// Create a new [`BoxedUint`] from the provided big endian bytes.
///
Expand Down
71 changes: 71 additions & 0 deletions src/uint/boxed/encoding/serde.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
use serdect::serde::{Deserialize, Deserializer, Serialize, Serializer, de::Error};

use crate::BoxedUint;

impl<'de> Deserialize<'de> for BoxedUint {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: Deserializer<'de>,
{
let slice = serdect::slice::deserialize_hex_or_bin_vec(deserializer)?;
let bit_precision = (slice.len() as u32).checked_mul(8).ok_or(Error::custom(
"Deserialized value overflows u32 bit precision!",
))?;
Self::from_le_slice(&slice, bit_precision).map_err(Error::custom)
}
}

impl Serialize for BoxedUint {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
serdect::slice::serialize_hex_lower_or_bin(&self.to_le_bytes(), serializer)
}
}

#[cfg(test)]
mod tests {
use super::BoxedUint;
#[cfg(target_pointer_width = "32")]
use crate::Limb;
#[cfg(target_pointer_width = "32")]
use hex_literal::hex;

#[test]
#[cfg(target_pointer_width = "64")]
fn serde() {
let test: BoxedUint = BoxedUint::from_be_hex("7711223344556600", 64).unwrap();

let serialized = bincode::serialize(&test).unwrap();
let deserialized: BoxedUint = bincode::deserialize(&serialized).unwrap();

assert_eq!(test, deserialized);
}

#[test]
#[cfg(target_pointer_width = "64")]
fn serde_owned() {
let test: BoxedUint = BoxedUint::from_be_hex("7711223344556600", 64).unwrap();

let serialized = bincode::serialize(&test).unwrap();
let deserialized: BoxedUint = bincode::deserialize_from(serialized.as_slice()).unwrap();

assert_eq!(test, deserialized);
}

#[test]
#[cfg(target_pointer_width = "32")]
fn from_le_slice_eq_test() {
let bytes = hex!("7766554433221100");
let box_uint = BoxedUint::from_le_slice(&bytes, 64).unwrap();

let serialized = bincode::serialize(&box_uint).unwrap();
let deserialized: BoxedUint = bincode::deserialize_from(serialized.as_slice()).unwrap();

assert_eq!(
deserialized.as_limbs(),
&[Limb(0x44556677), Limb(0x00112233)]
);
}
}