Struct LocatedNodeList 

pub struct LocatedNodeList<'a, T: VariantValue>(/* private fields */);

A list of LocatedNode resulting from an SPath query, along with their locations.

Implementations

impl<'a, T: VariantValue> LocatedNodeList<'a, T>

pub fn new(nodes: Vec<LocatedNode<'a, T>>) -> Self

Create a new LocatedNodeList from a vector of located nodes.

pub fn at_most_one(self) -> Result<Option<LocatedNode<'a, T>>, AtMostOneError>

Extract at most one entry from a LocatedNodeList

This is intended for queries that are expected to optionally yield a single node.

pub fn exactly_one(self) -> Result<LocatedNode<'a, T>, ExactlyOneError>

Extract exactly one entry from a LocatedNodeList

This is intended for queries that are expected to yield a single node.

pub fn all(self) -> Vec<LocatedNode<'a, T>>

Extract all located nodes yielded by the query

This is intended for queries that are expected to yield zero or more nodes.

pub fn len(&self) -> usize

Get the length of a LocatedNodeList

pub fn is_empty(&self) -> bool

Check if a LocatedNodeList is empty

pub fn iter(&self) -> Iter<'_, LocatedNode<'a, T>>

Get an iterator over a LocatedNodeList

Note that LocatedNodeList also implements IntoIterator.

To iterate over just locations, see locations. To iterate over just nodes, see nodes.

pub fn locations(&self) -> Locations<'_, T>

Get an iterator over the locations of nodes within a LocatedNodeList

pub fn nodes(&self) -> Nodes<'_, T>

Get an iterator over the nodes within a LocatedNodeList

pub fn dedup(self) -> Self

Deduplicate a LocatedNodeList and return the result

See also, dedup_in_place.

pub fn dedup_in_place(&mut self)

Deduplicate a LocatedNodeList in-place

See also, dedup.

pub fn first(&self) -> Option<&LocatedNode<'a, T>>

Return the first entry in the LocatedNodeList, or None if it is empty

pub fn last(&self) -> Option<&LocatedNode<'a, T>>

Return the last entry in the LocatedNodeList, or None if it is empty

pub fn get(&self, index: usize) -> Option<&LocatedNode<'a, T>>

Returns the node at the given index in the LocatedNodeList, or None if the given index is out of bounds.

Trait Implementations

impl<'a, T: Clone + VariantValue> Clone for LocatedNodeList<'a, T>

fn clone(&self) -> LocatedNodeList<'a, T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T: Debug + VariantValue> Debug for LocatedNodeList<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Default + VariantValue> Default for LocatedNodeList<'a, T>

fn default() -> LocatedNodeList<'a, T>

Returns the “default value” for a type.

impl<'a, T: VariantValue> IntoIterator for LocatedNodeList<'a, T>

type Item = LocatedNode<'a, T>

The type of the elements being iterated over.

type IntoIter = IntoIter<<LocatedNodeList<'a, T> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: PartialEq + VariantValue> PartialEq for LocatedNodeList<'a, T>

fn eq(&self, other: &LocatedNodeList<'a, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T: Eq + VariantValue> Eq for LocatedNodeList<'a, T>

impl<'a, T: VariantValue> StructuralPartialEq for LocatedNodeList<'a, T>