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.
• minidom_compat
  Implementations of traits from this crate for minidom types

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.
• DiscardEvents
  FromEventsBuilder implementation which consumes and discards the entire XML element.
• 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
• OptionEventIter
  Event iterator for Option<T>.
• OptionFromEventsBuilder
  Builder to construct an Option<T> from XML events.
• 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

• FromEventsError
  Error returned from FromXml::from_events.
• 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.
• FromEventsBuilder
  Trait for a temporary object allowing to construct a struct from `rxml::Event items.
• FromOptionalXmlText
  Provide construction of a value from optional XML text data.
• FromXml
  Trait allowing to construct a struct from a stream of rxml::Event items.
• FromXmlText
  Convert XML text to a value.
• IntoOptionalXmlText
  Provide destruction of a value into optional XML text data.
• IntoXml
  Trait allowing to consume a struct and iterate its contents as serialisable rxml::Event items.
• IntoXmlText
  Convert a value into XML text.
• IterItems
  Trait allowing to iterate the contents of a struct as serialisable rxml::Item items.
• 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.

Functions

• transform
  Attempt to transform a type implementing IntoXml into another type which implements FromXml.
• try_from_element
  Attempt to convert a minidom::Element into a type implementing FromXml, fallably.

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