Struct html_page::Element

pub struct Element { /* private fields */ }

An HTML element.

The element has a Tag, possibly some attributes, and possibly some children. It may also have a location: this is used when the element is constructed by parsing some input value.

Implementations

impl Element

pub fn new(tag: Tag) -> Self

Create a new element, with a given tag.

pub fn with_location(self, line: usize, col: usize) -> Self

Set the location of an element in a source file.

pub fn with_child(self, child: Element) -> Self

Append a child element, when constructing.

pub fn with_text(self, child: &str) -> Self

Append a text child, when constructing.

pub fn with_attribute(self, name: &str, value: &str) -> Self

Set an attribute when creating an element.

pub fn with_boolean_attribute(self, name: &str) -> Self

Set a boolean attribute when creating an element.

pub fn with_class(self, class: &str) -> Self

Add a class when creating an element.

pub fn tag(&self) -> Tag

Return the Tag of the element.

pub fn location(&self) -> Option<(usize, usize)>

Return the location of the element.

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

Return an iterator over the names of the attributes of an element.

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

Return the value of an attribute, if the attribute is set. Otherwise, return None.

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

Return the value of an attribute as text, if the attribute is set. Otherwise, return None.

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

Set a key/value attribute. If the attribute was already set, change the value it has.

pub fn set_boolean_attribute(&mut self, name: &str)

Set a boolean attribute.

pub fn unset_attribute(&mut self, name: &str)

Remove an attribute, which can be key/value or boolean.

pub fn classes(&self) -> impl Iterator<Item = &str>

Return current classes set directly for this element.

pub fn has_class(&self, wanted: &str) -> bool

Does the element have a class set directly?

pub fn add_class(&mut self, class: &str)

Add a class to the element. This does not replace existing classes.

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

Append text to element. It will be escaped, if needed, when the element is serialized.

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

Append a child element to this element.

pub fn clear_children(&mut self)

Remove all children.

pub fn push_html(&mut self, html: &str)

Append HTML to element. It will NOT be escaped, when the element is serialized. This is an easy to inject arbitrary junk into the HTML. No validation is done. You should avoid this if you can.

pub fn serialize(&self) -> String

Serialize an element into HTML.

pub fn plain_text(&self) -> String

Return all the textual content in an element and its children. This does not include attributes.

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 Display for Element

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

Formats the value using the given formatter.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Element

impl StructuralPartialEq for Element