Struct NodeList 

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

A list of nodes resulting from an SPath query.

Each node within the list is a borrowed reference to the node in the original VariantValue that was queried.

Implementations

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

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

Create a new NodeList from a vector of nodes

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

Extract at most one node from a NodeList

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

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

Extract exactly one node from a NodeList

This is intended for queries that are expected to yield exactly one node.

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

Extract all 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 NodeList

pub fn is_empty(&self) -> bool

Check if a NodeList is empty

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

Get an iterator over a NodeList

Note that NodeList also implements IntoIterator.

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

Returns the first node in the NodeList, or None if it is empty

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

Returns the last node in the NodeList, or None if it is empty

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

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

Trait Implementations

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

fn clone(&self) -> NodeList<'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 NodeList<'a, T>

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

Formats the value using the given formatter.

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

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

Returns the “default value” for a type.

impl<'a, T: VariantValue> From<NodeList<'a, T>> for NodesType<'a, T>

fn from(value: NodeList<'a, T>) -> Self

Converts to this type from the input type.

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

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = IntoIter<<NodeList<'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 NodeList<'a, T>

fn eq(&self, other: &NodeList<'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 NodeList<'a, T>

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