Skip to content
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.

Sign up for GitHub

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

fix: Make NodeId deserializable from serde_json::Value #63

Merged
merged 2 commits into from
Oct 22, 2023
Merged

fix: Make NodeId deserializable from serde_json::Value #63

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9392350
fix: Make NodeId deserializable from serde_json::Value
morph-dev Oct 20, 2023
a06a2ed
use owned strings only when necessary
divagant-martian Oct 22, 2023
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
31 changes: 28 additions & 3 deletions src/node_id.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ impl std::fmt::Debug for NodeId {
/// Serialize with the 0x prefix.
#[cfg(feature = "serde")]
mod serde_hex_prfx {

pub fn serialize<T: AsRef<[u8]> + hex::ToHex, S: serde::Serializer>(
data: &T,
serializer: S,
Expand All @@ -122,8 +123,16 @@ mod serde_hex_prfx {
T: hex::FromHex,
<T as hex::FromHex>::Error: std::fmt::Display,
{
let raw: &[u8] = serde::Deserialize::deserialize(deserializer)?;
let src = raw.strip_prefix(b"0x").unwrap_or(raw);
/// Helper struct to obtain a owned string when necessary (using [`serde_json`], for
/// example) or a borrowed string with the appropriate lifetime (most the time).
// NOTE: see https://github.com/serde-rs/serde/issues/1413#issuecomment-494892266 and
// https://github.com/sigp/enr/issues/62
#[derive(serde::Deserialize)]
struct CowNodeId<'a>(#[serde(borrow)] std::borrow::Cow<'a, str>);

let CowNodeId::<'de>(raw) = serde::Deserialize::deserialize(deserializer)?;

let src = raw.strip_prefix("0x").unwrap_or(&raw);
hex::FromHex::from_hex(src).map_err(serde::de::Error::custom)
}
}
Expand All @@ -143,12 +152,28 @@ mod tests {

#[cfg(feature = "serde")]
#[test]
fn test_serde() {
fn test_serde_str() {
let node = NodeId::random();
let json_string = serde_json::to_string(&node).unwrap();
assert_eq!(node, serde_json::from_str::<NodeId>(&json_string).unwrap());
}

#[cfg(feature = "serde")]
#[test]
fn test_serde_slice() {
let node = NodeId::random();
let json_bytes = serde_json::to_vec(&node).unwrap();
assert_eq!(node, serde_json::from_slice::<NodeId>(&json_bytes).unwrap());
}

#[cfg(feature = "serde")]
#[test]
fn test_serde_value() {
let node = NodeId::random();
let value = serde_json::to_value(&node).unwrap();
assert_eq!(node, serde_json::from_value::<NodeId>(value).unwrap());
}

#[cfg(feature = "serde")]
#[test]
fn test_serde_0x() {
Expand Down