Struct exile::Element

pub struct Element { /* fields omitted */ }

Represents an Element in an XML Document.

Implementations

impl Element

pub fn from_name<S: Into<String>>(name: S) -> Self

Create a new element using the given name.

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

Returns the ‘child’ elements of the current element. Consider the XML document:

<r>
  <a/>
  <b/>
</r>

r’s children() function would return an iterator over ‘a’ and ‘b’. Text nodes, processing instructions and comments are skipped/ignored by the iterator.

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

Returns the ‘child’ elements of the current element. Consider the XML document:

<r>
  <a/>
  <b/>
</r>

r’s children_mut() function would return an iterator over ‘a’ and ‘b’. Text nodes, processing instructions and comments are skipped/ignored by the iterator.

pub fn child<S: AsRef<str>>(&self, name: S) -> Option<&Element>

Find the first occurrance specific child element (does not recurse to lower levels of children).

pub fn add_child(&mut self, element: Element)

Add an element as a child of this element.

pub fn add_cdata<S: Into<String>>(&mut self, cdata: S) -> Result<(), XDocErr>

Add a CDATA node. Will error if the string contains ]]> as this cannot be represented in a CDATA node.

pub fn nodes_len(&self) -> usize

Get the number of nodes (of any kind) that are children of this node.

pub fn first_node(&self) -> Option<&Node>

Get the first child node (of any kind)

pub fn node(&self, index: usize) -> Option<&Node>

Get the child node (of any kind) at index.

pub fn fullname(&self) -> &str

The fullname of the element (including both the namespace alias prefix and the name). For example, if the name of this element is ns:foo, this function returns "ns:foo". Element::name and [Element:prefix] give the parsed sections of the fullname.

pub fn name(&self) -> &str

The name of the element without its prefix. For example, if the name of this element is ns:foo, name() will return foo.

pub fn prefix(&self) -> Option<&str>

The name of the element’s namespace alias prefix. For example, if the name of this element is ns:foo, prefix() will return Some("ns").

pub fn set_name<S: AsRef<str>>(&mut self, name: S)

Sets the name of this element without changing the namespace alias prefix. For example, if the name of this element is ns:foo then set_name("bar") will change the fullname to ns:bar.

pub fn set_prefix<S: AsRef<str>>(&mut self, prefix: S) -> Result<(), XDocErr>

Sets the namespace alias prefix of this element without changing the name. For example, if the name of this element is ns:foo then set_prefix("xyz:) will change the fullname to xyz:foo`.

pub fn set_fullname<S: Into<String>>(
    &mut self,
    fullname: S
) -> Result<(), XDocErr>

Sets the fullname of the element. For example, if the name of this element is ns:foo, then set_fullname("xyz:baz") will set the fullname to xyz:baz. set_fullname("baz") will eliminate any existing namespace alias prefix and set the fullname to baz.

pub fn add_attribute<K, V>(&mut self, key: K, value: V) -> Option<String> where
    K: AsRef<str>,
    V: AsRef<str>, 

Inserts a key-value pair into the attributes map.

If the map did not have this key present, None is returned.

If the map did have this key present, the value is updated, and the old value is returned.

pub fn attribute<S: AsRef<str>>(&self, key: S) -> Option<&String>

Gets the attribute value at key. None if an attribute by that name does not exist.

pub fn attributes_len(&self) -> usize

Gets the count of attributes.

pub fn attributes(&self) -> impl Iterator<Item = (&String, &String)> + '_

Gets an iterator over the attribute key/value pairs.

pub fn attribute_keys(&self) -> impl Iterator<Item = &String> + '_

Gets an iterator over the attribute keys

pub fn add_new_child(&mut self) -> Result<&mut Element, XDocErr>

Creates a new element as the last child of this element and returns a mut ref to it.

pub fn add_text<S: AsRef<str>>(&mut self, text: S)

Append a text node to this element’s nodes.

pub fn add_pi(&mut self, pi: Pi)

Append a processing instruction to this element’s nodes.

pub fn add_comment<S: Into<String>>(
    &mut self,
    comment: S
) -> Result<(), XDocErr>

Append a processing instruction to this element’s nodes.

pub fn has_children(&self) -> bool

Does this element have any sub elements. For example, if the element is empty or contains only text and/or pis and/or comments, then false. if the element has elements, then true.

pub fn is_text(&self) -> bool

Returns true if there is exactly one sub node, and that sub node is either text or cdata.

pub fn text(&self) -> Option<String>

Returns the contents of the first Text or CData node encountered in the element. Useful for simple ‘text’ elements like <something>text is here</something> where this function will return Some("text is here").

pub fn write<W>(
    &self,
    writer: &mut W,
    opts: &WriteOpts,
    depth: usize
) -> Result<(), XDocErr> where
    W: Write, 

Write the element to the Write object.

Trait Implementations

impl Clone for Element

fn clone(&self) -> Element

Returns a copy 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 Default for Element

fn default() -> Self

Returns the “default value” for a type.

impl Display for Element

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

Formats the value using the given formatter.

impl Hash for Element

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Element

fn cmp(&self, other: &Element) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Element> for Element

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

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

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

This method tests for !=.

impl PartialOrd<Element> for Element

fn partial_cmp(&self, other: &Element) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Element

impl StructuralEq for Element

impl StructuralPartialEq for Element