Struct Queries

pub struct Queries<'a> { /* private fields */ }

A collection of XPath queries

You can register xpath expressions with conversion functions to turn the results into Rust values.

Implementations

impl<'a> Queries<'a>

pub fn new(default_static_context_builder: StaticContextBuilder<'a>) -> Self

Construct a new collection of queries

Supply a default static context builder, which is used by default to construct a static context if none is supplied explicitly.

pub fn one<V, F>(&self, s: &str, convert: F) -> Result<OneQuery<V, F>>

where F: Convert<V>,

Construct a query that expects a single item result.

This item is converted into a Rust value using supplied convert function.

This uses a default static context.

pub fn one_with_context<V, F>( &self, s: &str, convert: F, static_context: StaticContext, ) -> Result<OneQuery<V, F>>

where F: Convert<V>,

Construct a query that expects a single item result.

This item is converted into a Rust value using supplied convert function.

You can supply a static context explicitly.

pub fn one_recurse(&self, s: &str) -> Result<OneRecurseQuery>

Construct a query that expects a single item result.

This item is converted into a Rust value not using a convert function but through a recursive call that’s passed in during execution.

NOTE: recursion generally needs a stopping condition, but one_recurse expects one value always - unlike option_recurse and many_recurse which have the None or empty value. I think this means that one_recurse is not in fact useful.

pub fn one_recurse_with_context( &self, s: &str, static_context: StaticContext, ) -> Result<OneRecurseQuery>

Construct a query that expects a single item result, with explicit static context.

pub fn option<V, F>(&self, s: &str, convert: F) -> Result<OptionQuery<V, F>>

where F: Convert<V>,

Construct a query that expects an optional single item result.

This item is converted into a Rust value using supplied convert function.

pub fn option_with_context<V, F>( &self, s: &str, convert: F, static_context: StaticContext, ) -> Result<OptionQuery<V, F>>

where F: Convert<V>,

Construct a query that expects an optional single item result with explicit static context.

pub fn option_recurse(&self, s: &str) -> Result<OptionRecurseQuery>

Construct a recursive query that expects an optional single item result.

This item is converted into a Rust value not using a convert function but through a recursive call that’s passed in during execution.

pub fn option_recurse_with_context( &self, s: &str, static_context: StaticContext, ) -> Result<OptionRecurseQuery>

Construct a recursive query that expects an optional single item result, with explicit static context.

pub fn many<V, F>(&self, s: &str, convert: F) -> Result<ManyQuery<V, F>>

where F: Convert<V>,

Construct a query that expects many items as a result.

These items are converted into Rust values using supplied convert function.

pub fn many_with_context<V, F>( &self, s: &str, convert: F, static_context: StaticContext, ) -> Result<ManyQuery<V, F>>

where F: Convert<V>,

Construct a query that expects many items as a result, with explicit static context.

pub fn many_recurse(&self, s: &str) -> Result<ManyRecurseQuery>

Construct a query that expects many items as a result.

These items are converted into Rust values not using a convert function but through a recursive call that’s passed in during execution.

pub fn many_recurse_with_context( &self, s: &str, static_context: StaticContext, ) -> Result<ManyRecurseQuery>

Construct a recursive query that expects many items as a result, with explicit static context.

pub fn sequence(&self, s: &str) -> Result<SequenceQuery>

Construct a query that gets a [Sequence] as a result.

This is a low-level API that allows you to get the raw sequence without converting it into Rust values.

pub fn sequence_with_context( &self, s: &str, static_context: StaticContext, ) -> Result<SequenceQuery>

Construct a query that gets a [Sequence] as a result, with explicit static context.

Trait Implementations

impl<'a> Debug for Queries<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Default for Queries<'a>

fn default() -> Queries<'a>

Returns the “default value” for a type.