Crate xee_xpath 

This module provides a high level API to use XPath from Rust.

You can compile XPath expressions into queries using the Queries store. For each query you supply a conversion function that turns the result XPath sequence into a Rust value.

You can create a Documents store and load XML documents into it.

You can also add queries to a Queries object. You can then execute queries against the documents store.

use xee_xpath::{Documents, Queries, Query};

// create a new documents object
let mut documents = Documents::new();
// load a document from a string
let doc = documents.add_string("http://example.com".try_into().unwrap(), "<root>foo</root>").unwrap();

// create a new queries object
let queries = Queries::default();

// create a query expecting a single value in the result sequence
// try to convert this value into a Rust `String`
let q = queries.one("/root/string()", |_, item| {
  Ok(item.try_into_value::<String>()?)
})?;

// when we execute the query, we need to pass a mutable reference to the documents,
// and the item against which we want to query. We can also pass in a document handle,
// as we do here
let r = q.execute(&mut documents, doc)?;
assert_eq!(r, "foo");

Note that to represent URLs, we use the iri-string crate. To make an IriString from a string, you can use the try_into method:

use iri_string::types::IriString;

let uri: IriString = "http://example.com".try_into().unwrap();

To make an IriStr reference, just use & on an IriString; this is like the relationship between String and &str. You can also use the try_into method on a &str directly:

use iri_string::types::IriStr;

let uri: &IriStr = "http://example.com".try_into().unwrap();

Re-exports

pub use query::Query;

pub use query::Recurse;

Modules

atomic

Custom atomic types for XPath.

context

Context in order to construct and execute XPath queries.

error

Error handling

function

XPath Function types

iter

Various iterators.

query

Queries you can execute against a document.

Structs

DocumentHandle

A handle to a document.

Documents

A collection of XML documents as can be used by XPath and XSLT.

Queries

A collection of XPath queries

SerializationParameters

Enums

Atomic

An atomic value.

Item

An XPath item. These are the items that make up an XPath sequence.

Sequence

Traits

Itemable

Something that can be converted into an Item using a [Document]