Skip to content

Add reserved name #content to flatten element hierarchies. #6

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

Merged
merged 1 commit into from
Feb 3, 2025
Merged

Add reserved name #content to flatten element hierarchies. #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ license = "MIT OR Apache-2.0"
repository = "https://github.com/adamreichold/serde-roxmltree"
documentation = "https://docs.rs/serde-roxmltree"
readme = "README.md"
version = "0.8.4"
version = "0.9.0"
edition = "2021"

[dependencies]
Expand Down
179 changes: 146 additions & 33 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,9 @@
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! The reserved name `$text` is used to directly refer to the text within an element:
//! The reserved name `#content` is used to flatten one level of the hierarchy and
//! revisit those nodes and attributes as if embedded inside another struct. This can
//! useful to handle inner text:
//!
//! ```
//! use serde::Deserialize;
Expand All @@ -110,7 +112,7 @@
//!
//! #[derive(Deserialize)]
//! struct Child {
//! #[serde(rename = "$text")]
//! #[serde(rename = "#content")]
//! text: String,
//! attribute: i32,
//! }
Expand All @@ -122,6 +124,37 @@
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! or partial alternatives:
//!
//! ```
//! use serde::Deserialize;
//! use serde_roxmltree::from_str;
//!
//! #[derive(Debug, PartialEq, Deserialize)]
//! #[serde(rename_all = "lowercase")]
//! enum Alternative {
//! Float(f32),
//! Integer(i32),
//! }
//!
//! #[derive(Debug, PartialEq, Deserialize)]
//! struct Record {
//! #[serde(rename = "#content")]
//! alternative: Alternative,
//! string: String,
//! }
//!
//! let record = from_str::<Record>("<record><float>42.0</float><string>foo</string></record>")?;
//! assert_eq!(record.alternative, Alternative::Float(42.0));
//! assert_eq!(record.string, "foo");
//!
//! let record = from_str::<Record>("<record><integer>23</integer><string>bar</string></record>")?;
//! assert_eq!(record.alternative, Alternative::Integer(23));
//! assert_eq!(record.string, "bar");
//! #
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```
//!
//! Optionally, attribute names can be prefixed by `@` to distinguish them from tag names:
//!
//! ```
Expand Down Expand Up @@ -285,7 +318,7 @@ pub trait Options: Sized {

/// Only visit child elements
///
/// Does not visit attributes and `$text`
/// Does not visit attributes and `#content`
/// to improve efficiency when these are irrelevant.
fn only_children(self) -> OnlyChildren<Self> {
OnlyChildren(PhantomData)
Expand Down Expand Up @@ -361,28 +394,21 @@ struct Deserializer<'de, 'input, 'temp, O> {
enum Source<'de, 'input> {
Node(Node<'de, 'input>),
Attribute(Attribute<'de, 'input>),
Text(&'de str),
Content(Node<'de, 'input>),
}

#[derive(Default)]
struct Temp {
visited: BitSet<usize>,
buffer: String,
}

impl<'de, 'input, O> Deserializer<'de, 'input, '_, O>
where
O: Options,
{
fn name(&mut self) -> &str {
match &self.source {
Source::Node(node) => {
impl Source<'_, '_> {
fn name<'a, O>(&'a self, buffer: &'a mut String) -> &'a str
where
O: Options,
{
match self {
Self::Node(node) => {
let tag_name = node.tag_name();
let name = tag_name.name();

match tag_name.namespace() {
Some(namespace) if O::NAMESPACES => {
let buffer = &mut self.temp.buffer;
buffer.clear();

buffer.reserve(namespace.len() + 2 + name.len());
Expand All @@ -398,12 +424,11 @@ where
_ => name,
}
}
Source::Attribute(attr) => {
Self::Attribute(attr) => {
let name = attr.name();

match attr.namespace() {
Some(namespace) if O::NAMESPACES => {
let buffer = &mut self.temp.buffer;
buffer.clear();

if O::PREFIX_ATTR {
Expand All @@ -424,7 +449,6 @@ where
}
_ => {
if O::PREFIX_ATTR {
let buffer = &mut self.temp.buffer;
buffer.clear();

buffer.reserve(1 + name.len());
Expand All @@ -439,14 +463,29 @@ where
}
}
}
Source::Text(_) => "$text",
Self::Content(_) => "#content",
}
}
}

#[derive(Default)]
struct Temp {
visited: BitSet<usize>,
buffer: String,
}

impl<'de, 'input, O> Deserializer<'de, 'input, '_, O>
where
O: Options,
{
fn name(&mut self) -> &str {
self.source.name::<O>(&mut self.temp.buffer)
}

fn node(&self) -> Result<&Node<'de, 'input>, Error> {
match &self.source {
Source::Node(node) => Ok(node),
Source::Attribute(_) | Source::Text(_) => Err(Error::MissingNode),
Source::Node(node) | Source::Content(node) => Ok(node),
Source::Attribute(_) => Err(Error::MissingNode),
}
}

Expand All @@ -471,9 +510,9 @@ where

let attributes = node.attributes().map(Source::Attribute);

let text = once(Source::Text(node.text().unwrap_or_default()));
let content = once(Source::Content(*node));

Ok(children.chain(attributes).chain(text))
Ok(children.chain(attributes).chain(content))
}

fn siblings(&self) -> Result<impl Iterator<Item = Node<'de, 'de>>, Error> {
Expand All @@ -494,9 +533,8 @@ where

fn text(&self) -> &'de str {
match self.source {
Source::Node(node) => node.text().unwrap_or_default(),
Source::Node(node) | Source::Content(node) => node.text().unwrap_or_default(),
Source::Attribute(attr) => attr.value(),
Source::Text(text) => text,
}
}

Expand Down Expand Up @@ -733,7 +771,7 @@ where
fn deserialize_enum<V>(
self,
_name: &'static str,
_variants: &'static [&'static str],
variants: &'static [&'static str],
visitor: V,
) -> Result<V::Value, Self::Error>
where
Expand All @@ -742,12 +780,14 @@ where
if O::ONLY_CHILDREN {
visitor.visit_enum(EnumAccess {
source: self.children()?,
variants,
temp: self.temp,
options: PhantomData::<O>,
})
} else {
visitor.visit_enum(EnumAccess {
source: self.children_and_attributes()?,
variants,
temp: self.temp,
options: PhantomData::<O>,
})
Expand Down Expand Up @@ -874,6 +914,7 @@ where
I: Iterator<Item = Source<'de, 'input>>,
{
source: I,
variants: &'static [&'static str],
temp: &'temp mut Temp,
options: PhantomData<O>,
}
Expand All @@ -890,7 +931,13 @@ where
where
V: de::DeserializeSeed<'de>,
{
let source = self.source.next().ok_or(Error::MissingChildOrAttribute)?;
let source = self
.source
.find(|source| {
self.variants
.contains(&source.name::<O>(&mut self.temp.buffer))
})
.ok_or(Error::MissingChildOrAttribute)?;

let deserializer = Deserializer {
source,
Expand Down Expand Up @@ -1059,7 +1106,7 @@ mod tests {
#[derive(Deserialize)]
struct Child {
attr: i32,
#[serde(rename = "$text")]
#[serde(rename = "#content")]
text: u64,
}

Expand Down Expand Up @@ -1174,6 +1221,72 @@ mod tests {
assert_eq!(val, Root::Bar(42));
}

#[test]
fn mixed_enum_and_struct_children() {
#[derive(Debug, PartialEq, Deserialize)]
enum Foobar {
Foo(u32),
Bar(i64),
}

#[derive(Deserialize)]
struct Root {
#[serde(rename = "#content")]
foobar: Foobar,
qux: f32,
}

let val = from_str::<Root>(r#"<root><qux>42.0</qux><Foo>23</Foo></root>"#).unwrap();
assert_eq!(val.foobar, Foobar::Foo(23));
assert_eq!(val.qux, 42.0);
}

#[test]
fn mixed_enum_and_repeated_struct_children() {
#[derive(Debug, PartialEq, Deserialize)]
enum Foobar {
Foo(u32),
Bar(i64),
}

#[derive(Deserialize)]
struct Root {
#[serde(rename = "#content")]
foobar: Foobar,
qux: Vec<f32>,
baz: String,
}

let val = from_str::<Root>(
r#"<root><Bar>42</Bar><qux>1.0</qux><baz>baz</baz><qux>2.0</qux><qux>3.0</qux></root>"#,
)
.unwrap();
assert_eq!(val.foobar, Foobar::Bar(42));
assert_eq!(val.qux, [1.0, 2.0, 3.0]);
assert_eq!(val.baz, "baz");
}

#[test]
fn repeated_enum_and_struct_children() {
#[derive(Debug, PartialEq, Deserialize)]
enum Foobar {
Foo(Vec<u32>),
Bar(i64),
}

#[derive(Deserialize)]
struct Root {
#[serde(rename = "#content")]
foobar: Foobar,
baz: String,
}

let val =
from_str::<Root>(r#"<root><Foo>42</Foo><baz>baz</baz><Foo>23</Foo></root>"#).unwrap();
assert_eq!(val.foobar, Foobar::Foo(vec![42, 23]));
assert_eq!(val.baz, "baz");
}

#[test]
fn borrowed_str() {
let doc = Document::parse("<root><child>foobar</child></root>").unwrap();
Expand Down Expand Up @@ -1309,11 +1422,11 @@ mod tests {
}

#[test]
fn only_children_skips_text() {
fn only_children_skips_content() {
#[derive(Deserialize)]
struct Root {
child: u64,
#[serde(rename = "$text")]
#[serde(rename = "#content")]
text: Option<String>,
}

Expand Down