serde-roxmltree

将 roxmltree 文档转换为 Serde 兼容类型

许可

许可下

• Apache 许可证 2.0 版 或
• MIT 许可证

根据您的选择。

贡献

除非您明确声明，否则根据 Apache-2.0 许可证定义的您有意提交的任何贡献，将如上双许可，不附加任何额外条款或条件。

lib.rs:

将 roxmltree 文档转换为 serde 兼容类型

拥有类型可以直接使用 from_str 从 XML 文本反序列化

use serde::Deserialize;
use serde_roxmltree::from_str;

#[derive(Deserialize)]
struct Record {
    field: String,
}

let record = from_str::<Record>("<record><field>foobar</field></record>")?;
assert_eq!(record.field, "foobar");
#

借用类型必须使用 from_doc 从 Document 反序列化

use roxmltree::Document;
use serde::Deserialize;
use serde_roxmltree::from_doc;

#[derive(Deserialize)]
struct Record<'a> {
    field: &'a str,
}

let document = Document::parse("<document><field>foobar</field></document>")?;

let record = from_doc::<Record>(&document)?;
assert_eq!(record.field, "foobar");
#

结构体的字段映射到子元素和属性

use serde::Deserialize;
use serde_roxmltree::from_str;

#[derive(Deserialize)]
struct Record {
    child: String,
    attribute: i32,
}

let record = from_str::<Record>(r#"<record attribute="42"><child>foobar</child></record>"#)?;
assert_eq!(record.child, "foobar");
assert_eq!(record.attribute, 42);
#

序列收集重复的子元素

use serde::Deserialize;
use serde_roxmltree::from_str;

#[derive(Deserialize)]
struct Record {
    field: Vec<String>,
}

let record = from_str::<Record>("<record><field>foo</field><field>bar</field></record>")?;
assert_eq!(record.field, ["foo", "bar"]);
#

枚举变体描述替代项

use serde::Deserialize;
use serde_roxmltree::from_str;

#[derive(Debug, PartialEq, Deserialize)]
#[serde(rename_all = "lowercase")]
enum Record {
    Float(f32),
    Integer(i32),
}

let record = from_str::<Record>("<record><float>42.0</float></record>")?;
assert_eq!(record, Record::Float(42.0));

let record = from_str::<Record>("<record><integer>23</integer></record>")?;
assert_eq!(record, Record::Integer(23));
#

保留名称 $text 用于直接引用元素内的文本

use serde::Deserialize;
use serde_roxmltree::from_str;

#[derive(Deserialize)]
struct Record {
    child: Child,
}

#[derive(Deserialize)]
struct Child {
    #[serde(rename = "$text")]
    text: String,
    attribute: i32,
}

let record = from_str::<Record>(r#"<record><child attribute="42">foobar</child></record>"#)?;
assert_eq!(record.child.text, "foobar");
assert_eq!(record.child.attribute, 42);
#

可选地，可以通过在属性名称前加上 @ 来区分它们与标签名称

use serde::Deserialize;
use serde_roxmltree::{defaults, from_str, Options};

#[derive(Deserialize)]
struct Record {
    child: String,
    #[serde(rename = "@attribute")]
    attribute: i32,
}

let record = defaults().prefix_attr().from_str::<Record>(r#"<record attribute="42"><child>foobar</child></record>"#)?;
assert_eq!(record.child, "foobar");
assert_eq!(record.attribute, 42);
#

可以通过 namespaces 选项启用对 命名空间 的支持

use serde::Deserialize;
use serde_roxmltree::{defaults, from_str, Options};

let text = r#"<record xmlns:foo="http://foo" xmlns:bar="http://bar">
    <foo:qux>23</foo:qux>
    <bar:qux>42</bar:qux>
</record>"#;

#[derive(Deserialize)]
struct SomeRecord {
    qux: Vec<i32>,
}

let record = from_str::<SomeRecord>(text)?;
assert_eq!(record.qux, [23, 42]);

#[derive(Deserialize)]
struct AnotherRecord {
    #[serde(rename = "{http://foo}qux")]
    some_qux: i32,
    #[serde(rename = "{http://bar}qux")]
    another_qux: i32,
}

let record = defaults().namespaces().from_str::<AnotherRecord>(text)?;
assert_eq!(record.some_qux, 23);
assert_eq!(record.another_qux, 42);
#