Crate xso

Core types, macros and traits for parsing structs from XML

This crate provides the facilities for parsing XML data into Rust structs, and vice versa. Think of it as an alternative¹ to serde, more suited to XML.

To get started, use the FromXml and IntoXml derive macros on your struct. See in particular the documentation of FromXml for a full reference on the supported attributes.

XSO is an acronym for XML Stream(ed) Objects, referring to the main field of use of this library in parsing XML streams like specified in RFC 6120.

---

1. Though it should be said that you can combine serde and this crate on the same struct, no problem with that! ↩

Modules

• error
  Error types for parsing and serialisation.

Structs

• Base64
  Text codec transforming text to binary using standard base64.
• ColonSeparatedHex
  Text codec transforming text to binary by emitting it as colon-separated hex value.
• Discard
  Discard the value and do not emit a value.
• EmptyAsNone
  Text codec which returns None instead of the empty string.
• Hex
  Codec for bytes of lowercase hexadecimal, with a fixed length N (in bytes).
• NoFilter
  Text preprocessor which returns the input unchanged.
• NonEmptyString
  Shim wrapper around String which refuses to parse if the string is empty
• Plain
  Text codec which does no transform.
• StripWhitespace
  Text preprocessor to remove all whitespace.
• Trimmed
  Text codec which trims whitespace at the beginning and the end of the text.

Enums

• UnknownAttributePolicy
  Configure how unknown attributes are handled.
• UnknownChildPolicy
  Configure how unknown child elements are handled.

Traits

• DynNamespace
  Trait for structs implementing FromXml with namespace = dyn.
• DynNamespaceEnum
  Enumeration of possible dynamically determined namespaces.
• ElementCodec
  Trait to support destructuring of child structs beyond what the extract(..) attribute can deliver.
• FromOptionalXmlText
  Provide construction of a value from optional XML text data.
• FromXml
  Provide construction of structs from XML (sub-)trees.
• FromXmlText
  Convert XML text to a value.
• IntoOptionalXmlText
  Provide destruction of a value into optional XML text data.
• IntoXml
  Convert a struct into an XML tree.
• IntoXmlText
  Convert a value into XML text.
• TextCodec
  Represent a way to encode/decode text data into a Rust type.
• TextFilter
  Trait for preprocessing text data from XML.
• TryExtend
  Trait for fallible extension.

Derive Macros

• DynNamespace
  Make a struct fully dynamically namespaceable
• FromXml
  Make a struct or enum parseable from XML
• IntoXml
  Make a struct or enum convertible into XML