Crate xmlparser

xmlparser is a low-level, pull-based, zero-allocation XML 1.0 parser.

Example

for token in xmlparser::Tokenizer::from("<tagname name='value'/>") {
    println!("{:?}", token);
}

Why a new library

The main idea of this library is to provide a fast, low-level and complete XML parser.

Unlike other XML parsers, this one can return tokens not with &str/&[u8] data, but with StrSpan objects, which contain a position of the data in the original document. Which can be very useful if you want to post-process tokens even more and want to return errors with a meaningful position.

So, this is basically an XML parser framework that can be used to write parsers for XML-based formats, like SVG and to construct a DOM.

At the time of writing the only option was quick-xml (v0.10), which does not support DTD and token positions.

Benefits

• Tokens contain StrSpan objects, that contains a position of the data in the original document.
• Supports basic text escaping with xml:space (should be invoked manually). A properer text escaping is very hard without a DOM construction.
• Good error processing. All error types contain position (line:column) where it occurred.
• No heap allocations.

Limitations

• Currently, only ENTITY objects are parsed from the DOCTYPE. Other ignored.
• No tree structure validation. So an XML like <root><child></root></child> will be parsed without errors. You should check for this manually.
• Duplicated attributes is not an error. So an XML like <item a="v1" a="v2"/> will be parsed without errors. You should check for this manually.
• UTF-8 only.

Safety

• The library should not panic. Any panic considered as a critical bug and should be reported.
• The library forbids unsafe code.

Structs

ErrorPos	Position of the error.
StrSpan	An immutable string slice.
Stream	A streaming text parsing interface.
TextUnescape	An XML escaped text to plain text converter.
Tokenizer	Tokenizer for the XML structure.

Enums

ElementEnd	ElementEnd token.
EntityDefinition	Representation of the EntityDef value.
Error	An XML parser errors.
ExternalId	Representation of the ExternalID value.
Reference	Representation of the Reference value.
StreamError	A stream parser errors.
Token	An XML token.
TokenType	List of token types.
XmlSpace	Representation of the xml:space attribute.

Traits

XmlByteExt	Extension methods for XML-subset only operations.
XmlCharExt	Extension methods for XML-subset only operations.