Struct Element

Source

pub struct Element { /* private fields */ }

Expand description

Represents an XML element, including its name, attributes, and child elements.

This is the core abstraction over an XML DOM node. It provides methods for building and formatting XML trees programmatically.

§Examples

use apk_info_xml::Element;

let mut root = Element::new("root");

root.set_attribute("version", "1.0");
root.set_attribute_with_prefix(Some("xml"), "lang", "en");

let mut child = Element::new("child");
child.append_child(Element::new("grandchild"));

println!("{}", root);

Implementations§

Source §

impl Element

Source

pub fn new(name: &str) -> Element

Creates a new Element with the specified tag name and no attributes or children.

§Example

use apk_info_xml::Element;

let e = Element::new("root");
assert_eq!(e.name(), "root");

Source

pub fn with_capacity(name: &str, capacity: usize) -> Element

Creates a new Element with the specified tag name and preallocated space for attributes

§Example

use apk_info_xml::Element;

let e = Element::with_capacity("root", 16);
assert_eq!(e.name(), "root");

Source

pub fn set_attribute(&mut self, name: &str, value: &str)

Adds a new attribute without a namespace prefix to the element.

§Example

use apk_info_xml::Element;

let e = Element::new("node").set_attribute("id", "42");

Source

pub fn set_attribute_with_prefix( &mut self, prefix: Option<&str>, name: &str, value: &str, )

Adds a new attribute with an optional namespace prefix to the element.

§Example

use apk_info_xml::Element;

let mut e = Element::new("svg");
e.set_attribute_with_prefix(Some("xlink"), "href", "image.png");

assert!(e.attributes().collect::<Vec<_>>().len() > 0)

Source

pub fn set_text(&mut self, text: &str)

Sets the text content of this element (e.g. <string>value</string>).

§Example

use apk_info_xml::Element;

let mut s = Element::new("string");
s.set_attribute("name", "app_name");
s.set_text("Hello & welcome");
assert_eq!(s.to_string(), "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<string name=\"app_name\">Hello &amp; welcome</string>\n");

Source

pub fn append_child(&mut self, child: Element)

Appends a new child Element to this element.

§Example

use apk_info_xml::Element;

let mut root = Element::new("root");
root.append_child(Element::new("child"));

Source

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

Returns an iterator over all child elements.

§Example

use apk_info_xml::Element;

let mut root = Element::new("root");
root.append_child(Element::new("child"));

assert_eq!(root.childrens().count(), 1);

Source

pub fn descendants(&self) -> Descendants<'_> ⓘ

Return an iterator over all Element’s from the current root

§Example

use apk_info_xml::Element;

let mut root = Element::new("root");
let mut child = Element::new("child");
child.append_child(Element::new("subchild"));
root.append_child(child);

assert_eq!(root.descendants().count(), 2);

Source

pub fn attributes(&self) -> impl Iterator<Item = &Attribute>

Returns an iterator over the element’s attributes.

§Example

use apk_info_xml::Element;

let mut e = Element::new("node");
e.set_attribute("id", "42");
assert_eq!(e.attributes().count(), 1);

Source

pub fn name(&self) -> &str

Returns the element’s tag name.

Source

pub fn attr(&self, name: &str) -> Option<&str>

Retrieves the value of an attribute by name, if present.

§Example

use apk_info_xml::Element;

let mut e = Element::new("node");
e.set_attribute("id", "42");
assert_eq!(e.attr("id"), Some("42"));
assert_eq!(e.attr("missing"), None);