1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
//! # deprecated //! //! `xmlparser-dervie` has been renamed to `strong-xml` since v0.1.2. //! //! A proc macro to generate functions for writing to //! and parsing from xml string, based on xmlparser. //! //! ## Quick Start //! //! ```toml //! xmlparser = "0.13.0" //! xmlparser-derive = "0.1.0" //! ``` //! //! ```rust //! use std::borrow::Cow; //! use xmlparser_derive::{XmlRead, XmlWrite}; //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "parent")] //! struct Parent<'a> { //! #[xml(attr = "attr1")] //! attr1: Cow<'a, str>, //! #[xml(attr = "attr2")] //! attr2: Option<Cow<'a, str>>, //! #[xml(child = "child")] //! child: Vec<Child<'a>>, //! } //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "child")] //! struct Child<'a> { //! #[xml(text)] //! text: Cow<'a, str>, //! } //! //! assert_eq!( //! (Parent { attr1: "val".into(), attr2: None, child: vec![] }).to_string().unwrap(), //! r#"<parent attr1="val"></parent>"# //! ); //! //! assert_eq!( //! Parent::from_str(r#"<parent attr1="val" attr2="val"><child></child></parent>"#).unwrap(), //! Parent { attr1: "val".into(), attr2: Some("val".into()), child: vec![Child { text: "".into() }] } //! ); //! ``` //! //! ## Attributes //! //! ### `#[xml(tag = "")]` //! //! Specifies the xml tag of a struct or an enum variant. //! //! ```rust //! # use xmlparser_derive::{XmlRead, XmlWrite}; //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "parent")] //! struct Parent {} //! //! assert_eq!( //! (Parent {}).to_string().unwrap(), //! r#"<parent></parent>"# //! ); //! //! assert_eq!( //! Parent::from_str(r#"<parent></parent>"#).unwrap(), //! Parent {} //! ); //! ``` //! //! ```rust //! # use xmlparser_derive::{XmlRead, XmlWrite}; //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "tag1")] //! struct Tag1 {} //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "tag2")] //! struct Tag2 {} //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! enum Tag { //! #[xml(tag = "tag1")] //! Tag1(Tag1), //! #[xml(tag = "tag2")] //! Tag2(Tag2), //! } //! //! assert_eq!( //! (Tag::Tag1(Tag1 {})).to_string().unwrap(), //! r#"<tag1></tag1>"# //! ); //! //! assert_eq!( //! Tag::from_str(r#"<tag2></tag2>"#).unwrap(), //! Tag::Tag2(Tag2 {}) //! ); //! ``` //! //! ### `#[xml(attr = "")]` //! //! Specifies that a struct field is attribute. Support //! `Cow<str>`, `Option<Cow<str>>`, `bool`, `Option<bool>`, //! `usize`, `Option<usize>`, `T` and `Option<T>` where //! `T: std::str::FromStr`. //! //! ```rust //! use xmlparser_derive::{XmlRead, XmlWrite}; //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "parent")] //! struct Parent { //! #[xml(attr = "attr")] //! attr: usize //! } //! //! assert_eq!( //! (Parent { attr: 42 }).to_string().unwrap(), //! r#"<parent attr="42"></parent>"# //! ); //! //! assert_eq!( //! Parent::from_str(r#"<parent attr="48"></parent>"#).unwrap(), //! Parent { attr: 48 } //! ); //! ``` //! //! ### `#[xml(leaf)]` //! //! Specifies that a sturct is leaf element. //! //! ```rust //! # use xmlparser_derive::{XmlRead, XmlWrite}; //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(leaf, tag = "leaf")] //! struct Leaf {} //! //! assert_eq!( //! (Leaf {}).to_string().unwrap(), //! r#"<leaf/>"# //! ); //! //! assert_eq!( //! Leaf::from_str(r#"<leaf/>"#).unwrap(), //! Leaf {} //! ); //! ``` //! //! ### `#[xml(child = "")]` //! //! Specifies that a struct field is a child element. Support //! `T`, `Option<T>`, `Vec<T>` where `T: XmlRead + XmlWrite`. //! //! ```rust //! use xmlparser_derive::{XmlRead, XmlWrite}; //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "tag1")] //! struct Tag1 {} //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "tag2")] //! struct Tag2 {} //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "tag3")] //! struct Tag3 {} //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! enum Tag12 { //! #[xml(tag = "tag1")] //! Tag1(Tag1), //! #[xml(tag = "tag2")] //! Tag2(Tag2), //! } //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "parent")] //! struct Parent { //! #[xml(child = "tag3")] //! tag3: Vec<Tag3>, //! #[xml(child = "tag1", child = "tag2")] //! tag12: Option<Tag12> //! } //! //! assert_eq!( //! (Parent { tag3: vec![Tag3 {}], tag12: None }).to_string().unwrap(), //! r#"<parent><tag3></tag3></parent>"# //! ); //! //! assert_eq!( //! Parent::from_str(r#"<parent><tag2></tag2></parent>"#).unwrap(), //! Parent { tag3: vec![], tag12: Some(Tag12::Tag2(Tag2 {})) } //! ); //! ``` //! //! ### `#[xml(text)]` //! //! Specifies that a struct field is text content. //! Support `Cow<str>`. //! //! ```rust //! use std::borrow::Cow; //! use xmlparser_derive::{XmlRead, XmlWrite}; //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "parent")] //! struct Parent<'a> { //! #[xml(text)] //! content: Cow<'a, str>, //! } //! //! assert_eq!( //! (Parent { content: "content".into() }).to_string().unwrap(), //! r#"<parent>content</parent>"# //! ); //! //! assert_eq!( //! Parent::from_str(r#"<parent></parent>"#).unwrap(), //! Parent { content: "".into() } //! ); //! ``` //! //! ### `#[xml(flatten_text = "")]` //! //! Specifies that a struct field is child text element. //! Support `Cow<str>`, `Vec<Cow<str>>` and `Option<Cow<str>>`. //! //! ```rust //! use std::borrow::Cow; //! use xmlparser_derive::{XmlRead, XmlWrite}; //! //! #[derive(XmlWrite, XmlRead, PartialEq, Debug)] //! #[xml(tag = "parent")] //! struct Parent<'a> { //! #[xml(flatten_text = "child")] //! content: Cow<'a, str>, //! } //! //! assert_eq!( //! (Parent { content: "content".into() }).to_string().unwrap(), //! r#"<parent><child>content</child></parent>"# //! ); //! //! assert_eq!( //! Parent::from_str(r#"<parent><child></child></parent>"#).unwrap(), //! Parent { content: "".into() } //! ); //! ``` //! //! ## License //! //! MIT pub use xmlparser_derive_core::{XmlRead, XmlWrite}; pub use xmlparser_derive_utils::{XmlError, XmlReader, XmlResult}; pub mod utils { pub use xmlparser_derive_utils::{ read_text, read_till_element_start, read_to_end, xml_escape, xml_unescape, }; }