Module quick_xml

The quick_xml module contains helper types for serializing and deserializing generated code using the quick_xml crate.

Re-exports

pub use self::reader::ErrorReader;

pub use self::reader::IoReader;

pub use self::reader::SliceReader;

pub use self::reader::XmlReader;

pub use self::reader::XmlReaderSync;

Modules

reader

Defines and implements different helper traits that are needed for the deserialization process with the quick_xml crate.

Structs

BytesCData

CDATA content contains unescaped data from the reader. If you want to write them as a text, convert it to BytesText.

BytesDecl

An XML declaration (Event::Decl).

BytesEnd

Closing tag data (Event::End): </name>.

BytesPI

Processing instructions (PIs) allow documents to contain instructions for applications.

BytesStart

Opening tag data (Event::Start), with optional attributes: <name attr="value">.

BytesText

Data from various events (most notably, Event::Text) that stored in XML in escaped form. Internally data is stored in escaped form.

ContentDeserializer

Implements a Deserializer for any type that implements DeserializeBytes.

DeserializeStrError

Error that is raised by the DeserializeBytes trait if the type implements FromStr, but the conversion from the string has failed.

DeserializerOutput

Type that is used to bundle the output of a Deserializer operation.

Error

Quick XML Error

LocalName

A local (unqualified) name of an element or an attribute, i.e. a name without prefix.

Namespace

A namespace name that is declared in a xmlns[:prefix]="namespace name".

QName

A qualified name of an element or an attribute, including an optional namespace prefix and a local name.

RawByteStr

Helper type that implements Debug and Display for a byte slice.

UnionError

Contains the different errors that occurred when deserializing a union.

Writer

XML writer. Writes XML Events to a std::io::Write implementor.

Enums

ContentSerializer

Implements a Serializer for any type that implements SerializeBytes.

DeserializerArtifact

Artifact that is returned by a Deserializer.

DeserializerEvent

Indicates what to do with a event returned by a deserializer

ElementHandlerOutput

Controls the flow of the deserializer

ErrorKind

Quick XML error kind.

Event

Event emitted by Reader::read_event_into.

IterSerializer

Implements a Serializer for any type that implements an Iterator that emits references to a type that implements WithSerializer.

ResolveResult

Result of prefix resolution which creates by NsReader::resolve_attribute, NsReader::resolve_element, NsReader::read_resolved_event and NsReader::read_resolved_event_into methods.

Traits

DeserializeBytes

Trait that could be implemented by types to support deserialization from XML byte streams using the quick_xml crate.

DeserializeReader

Reader trait with additional helper methods for deserializing.

DeserializeSync

Trait that could be implemented by types to support deserialization from XML using the quick_xml crate.

Deserializer

Trait that defines a deserializer that can be used to construct a type from a XML Events.

SerializeBytes

Trait that could be implemented by types to support serialization to XML byte streams.

SerializeSync

Trait that could be implemented by types to support serialization to XML using the quick_xml crate.

Serializer

Trait that defines a serializer that can be used to destruct a type to suitable XML Events.

WithBoxedSerializer

Trait that returns a boxed version of a Serializer for any type that implements WithSerializer.

WithDeserializer

Trait that defines the Deserializer for a type.

WithSerializer

Trait that defines the Serializer for a type.

XmlWrite

A trait for objects which are byte-oriented sinks.

Functions

filter_xmlns_attributes

Returns an iterator that yields all attributes of the passed bytes_start object, except the xmlns attributes.

write_attrib

Write the passed attrib to the passed bytes object.

write_attrib_opt

Write the passed attrib to the passed bytes object.

Type Aliases

BoxedSerializer

Boxed version of a Serializer.

DeserializerResult

Result type returned by the Deserializer trait.