Struct Element 

pub struct Element {
    pub name: Name,
    pub attrs: Vec<Attribute>,
    pub children: Vec<Node>,
    pub self_closing: bool,
}

An element: its name, its attributes in the order they were written, and its children.

Fields

name: Name

The element’s name.

attrs: Vec<Attribute>

Attributes in document order, including any namespace declarations.

children: Vec<Node>

Children in document order.

self_closing: bool

True when the element was written <a/>. Only consulted when there are no children, and exists so that a round trip does not rewrite every empty element in the document.

Implementations

impl Element

pub fn new(prefix: &str, local: &str, ns: Ns) -> Self

A new element with no attributes and no children.

pub fn is(&self, ns: &Ns, local: &str) -> bool

Whether this element has the given ODF name.

pub fn attr(&self, ns: &Ns, local: &str) -> Option<&str>

The value of an attribute, by namespace and local name.

pub fn attr_usize(&self, ns: &Ns, local: &str) -> Option<usize>

The value of an attribute, read as an integer. Absent, or present and unreadable, are the same answer: ODF’s own default applies either way and a document that says table:number-columns-repeated="many" is not a reason to refuse the document.

pub fn elements(&self) -> impl Iterator<Item = &Element>

Every child element, in order.

pub fn elements_indexed(&self) -> impl Iterator<Item = (usize, &Element)>

Every child element with its index among the children, which is the step a path through the tree takes to reach it.

pub fn at(&self, path: &[usize]) -> Option<&Element>

The element a path of child indices leads to, counting every node and not only the elements. An empty path is this element.

pub fn child_mut(&mut self, ns: &Ns, local: &str) -> Option<&mut Element>

The first child element with the given name, for changing it.

pub fn at_mut(&mut self, path: &[usize]) -> Option<&mut Element>

The same, for changing what is there.

pub fn set_attr(&mut self, name: Name, value: impl Into<String>)

Set an attribute: the value replaced where the attribute is there, the attribute appended where it is not.

pub fn remove_attr(&mut self, ns: &Ns, local: &str) -> Option<String>

Remove an attribute, answering the value it had.

pub fn name_for(&self, ns: &Ns, local: &str) -> Name

A name for writing under this element, in the prefix it declares for the namespace, or the conventional one where it declares none.

pub fn declares(&self, ns: &Ns) -> bool

Whether this element declares a namespace.

pub fn child(&self, ns: &Ns, local: &str) -> Option<&Element>

The first child element with the given name.

pub fn descendant(&self, ns: &Ns, local: &str) -> Option<&Element>

The first descendant element with the given name, depth first.

pub fn plain_text(&self) -> String

Every character of text under this element, with ODF’s own whitespace elements turned back into the characters they stand for.

text:s is a run of spaces, text:tab a tab and text:line-break a newline, because ODF collapses literal runs of whitespace and spells out what it means instead. This is what a spreadsheet cell’s displayed string and a search over a document both read.

Trait Implementations

impl Clone for Element

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Element

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

Formats the value using the given formatter.

impl Eq for Element

impl PartialEq for Element

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Element