Struct nutrimatic::ChildReader

pub struct ChildReader<'buf>(_);

A lazy reader of the children of a node.

This struct is created by the children method on Node. It conceptually represents a sequence of Nodes indexed by contiguous numbers, kind of like [Node]; however, it does not physically contain any instances, instead constructing them on demand.

Examples

use nutrimatic::Node;

// Materialize all the children of a node into a `Vec`.
fn collect_children<'a>(node: &Node<'a>) -> Vec<Node<'a>> {
    node.children().iter().collect()
}

Implementations

impl<'buf> ChildReader<'buf>

pub fn index(&self, index: usize) -> Node<'buf>

Returns the child at the given index, starting from 0. Children are in increasing order by character. If the index is not within bounds, this method will panic or return garbage.

pub fn len(&self) -> usize

Returns the number of children of the node.

pub fn is_empty(&self) -> bool

Returns true if the node has no children.

pub fn find(&self, ch: u8) -> Option<Node<'buf>>

Finds a child with the given character using binary search.

pub fn scan(&self, ch: u8) -> Option<Node<'buf>>

Finds a child with the given character by scanning through the children in order. This is useful when the character is known to be early in the list (in particular, the space character is always first if present).

pub fn iter<'reader>(&'reader self) -> ChildIter<'buf, 'reader>

Returns an iterator over the children.

Trait Implementations

impl<'buf> Clone for ChildReader<'buf>

fn clone(&self) -> ChildReader<'buf>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'buf> Copy for ChildReader<'buf>

impl<'buf> Debug for ChildReader<'buf>

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

Formats the value using the given formatter.

impl<'buf> Eq for ChildReader<'buf>

impl<'buf, 'reader> IntoIterator for &'reader ChildReader<'buf>

type Item = Node<'buf>

The type of the elements being iterated over.

type IntoIter = ChildIter<'buf, 'reader>

Which kind of iterator are we turning this into?

fn into_iter(self) -> ChildIter<'buf, 'reader>

Creates an iterator from a value.

impl<'buf> PartialEq<ChildReader<'buf>> for ChildReader<'buf>

fn eq(&self, other: &ChildReader<'buf>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ChildReader<'buf>) -> bool

This method tests for !=.

impl<'buf> StructuralEq for ChildReader<'buf>

impl<'buf> StructuralPartialEq for ChildReader<'buf>