Module rxml::parser

Restricted XML 1.0 parsing facilities

This module contains parsing facilities for processing a token stream generated by the Lexer. To satisfy different styles of tree building, the parsing step is again separated in two stages: the logical stage and the namespace/attribute resolution stage.

Logical stage

In the logical stage, the logical elements of the XML document are emitted as RawEvent structs. These may be used by end-users to build XML document models, but they are not completely validated even to the XML 1.0 specification. The caveats are documented at the Parser struct.

Namespace/attribute resolution stage

This stage resolves namespace declarations found in a stream of RawEvent structs and emits ResolvedEvent structs. It is implemented by the NamespaceResolver struct.

Together with the validation of the logical stage, this provides full conformity checks according to XML 1.0 and Namespaces for XML 1.0.

The downside of using this stage is added processing cost, because considerable dynamic allocations need to be performed per-element (for attribute hash maps). In addition, information about the prefixes used to declare namespaces is lost (but nothing should rely on those anyway).

Structs

EventMetrics

Carry measurement information about the event

LexerAdapter

Wrapper around Lexer and std::io::BufRead to provide a TokenRead.

NamespaceResolver

Namespace/Attribute resolver

Parser

Low-level restricted XML 1.0 parser

RawParser

Low-level, logical restricted XML 1.0 parser

Enums

RawEvent

Logical XML document parts

ResolvedEvent

High-level, logical XML document parts

XmlVersion

XML version number

Constants

XMLNS_XML

XML core namespace URI (for the xml: prefix)

XMLNS_XMLNS

XML namespace URI (for the xmlns: prefix)

Statics

ZERO_METRICS

Traits

Parse

Trait for parser-like structs.

TokenRead

Read individual tokens from a source

WithContext

Trait for things which can be constructed with a context::Context.

Type Definitions

NamespaceName

Shared namespace URI

RawQName

Pair of an optional namespace prefix and a localpart, commonly used in element and attribute names.

RcPtr

Wrapper pointer around namespace URIs

ResolvedQName

Pair of an optional namespace name (URI) and a localpart, commonly used in element and attribute names.