Crate rxml

Restricted XML parsing and encoding

This crate provides “restricted” parsing and encoding of XML 1.0 documents with namespacing.

Features (some call them restrictions)

• No external resources
• No custom entities
• No DTD whatsoever
• No processing instructions
• No comments
• UTF-8 only
• Namespacing-well-formedness enforced
• XML 1.0 only
• Streamed parsing (parser emits a subset of SAX events)
• Streamed encoding
• Parser can be driven push- and pull-based
• Tokio-based asynchronicity supported via the async feature and AsyncParser.

Example

use rxml::EventRead;
let doc = b"<?xml version='1.0'?><hello>World!</hello>";
let mut fp = rxml::FeedParser::default();
let result = rxml::as_eof_flag(fp.parse_all(&mut &doc[..], true, |ev| {
	println!("got event: {:?}", ev);
}));
// true indicates eof
assert_eq!(result.unwrap(), true);

High-level parser usage

Push-based usage

The FeedParser allows to push bits of XML into the parser as they arrive in the application and process the resulting ResolvedEvents as they happen.

Pull-based usage

If the parser should block while waiting for more data to arrive, a PullParser can be used instead. The PullParser requires a source which implements io::BufRead.

Usage with Tokio

Tokio is supported with the async feature. It offers the AsyncParser and the AsyncEventRead trait, which work similar to the PullParser. Instead of blocking, however, the async parser will yield control to other tasks.

Re-exports

pub use strings::CData;

pub use strings::CDataStr;

pub use strings::NCName;

pub use strings::NCNameStr;

pub use strings::Name;

pub use strings::NameStr;

Modules

error

Error types

lexer

XML 1.0 Lexer

parser

Restricted XML 1.0 parsing facilities

strings

Strongly-typed strings for use with XML 1.0 documents

writer

Writer for restricted XML 1.0

Macros

xml_cdata

XML 1.0 CData compliant string

xml_name

XML 1.0 Name compliant string

xml_ncname

Namespaces for XML 1.0 NCName compliant string

Structs

AsyncDriver

Asynchronous driver for parsers

BufferQueueDeprecated

Zero-copy buffered reader for a queue of byte slices.

Context

Shared context for multiple parsers

Encoder

Encodes XML into buffers.

Lexer

Restricted XML 1.0 lexer

LexerAdapter

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

LexerOptions

Hold options to configure a Lexer.

NamespaceResolver

Namespace/Attribute resolver

Parser

Low-level restricted XML 1.0 parser

PullDriver

Blocking driver for parsers

PushDriver

Non-blocking driver for parsers

RawParser

Low-level, logical restricted XML 1.0 parser

Enums

Error

Error types which may be returned from the parser or lexer.

Item

An encodable item.

RawEvent

Logical XML document parts

ResolvedEvent

High-level, logical XML document parts

XMLVersion

XML version number

Constants

VERSION

Package version

XMLNS_XML

XML core namespace URI (for the xml: prefix)

Traits

AsyncEventRead

Asynchronous source of individual XML events

AsyncEventReadExt

Helper trait for asynchronous sources of individual XML events

EventRead

Source for individual XML events

Parse

Trait for parser-like structs.

WithContext

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

Functions

as_eof_flag

Convert end-of-file-ness of a result to a boolean flag.

Type Definitions

AsyncParser

Tokio-compatible asynchronous parser

EventDeprecated

Compatibility alias, use ResolvedEvent directly instead.

FeedParser

Non-blocking parsing

PullParser

Blocking parsing

QNameDeprecated

Compatibility alias, use ResolvedQName directly instead.

RawQName

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

ResolvedQName

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

Result