Struct exile::Index

pub struct Index { /* fields omitted */ }

Produces an index for each Element in the [`Document’]. Provides lookups for an element’s parent. This requires ownership of the document and pins the document.

Example

use exile::Document;
let xml = "<a><b/><c><d>x</d><e/></c></a>";
let doc = exile::parse(xml).unwrap();

// create an index consuming the document
let index = doc.index();

// get the element at index 3 (depth-first numbering).
let d = index.element(3).unwrap();

// get that element's parent
let c = index.parent(&d).unwrap();

// prove it!
assert_eq!("c", c.name());

Implementations

impl Index

pub fn build(doc: Document) -> Self

Create an index from doc.

pub fn doc(&self) -> &Document

Access the inner Document.

pub fn root(&self) -> &Element

Access the root Element of the Document.

pub fn into_doc(self) -> Document

Destroy the index and return ownership of the inner Document.

pub fn element(&self, index: usize) -> Option<&Element>

Gets the element at index.

pub fn index(&self, element: &Element) -> Option<usize>

Gets the index of the given element.

pub fn parent(&self, element: &Element) -> Option<&Element>

Gets the parent of the given element.

pub fn parent_index(&self, element: usize) -> Option<usize>

Gets the index of the parent of the element (which is given by index in this case).

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.