Struct mt_dom::Element

pub struct Element<NS, TAG, LEAF, ATT, VAL> where
    NS: PartialEq + Clone + Debug,
    TAG: PartialEq + Debug,
    LEAF: PartialEq + Clone + Debug,
    ATT: PartialEq + Clone + Debug,
    VAL: PartialEq + Clone + Debug,  {
    pub namespace: Option<NS>,
    pub tag: TAG,
    pub attrs: Vec<Attribute<NS, ATT, VAL>>,
    pub children: Vec<Node<NS, TAG, LEAF, ATT, VAL>>,
    pub self_closing: bool,
}

Represents an element of the virtual node An element has a generic tag, this tag could be a static str tag, such as usage in html dom. Example of which are div, a, input, img, etc.

Tag is a generic type, which can represent a different DOM tree other than the html dom such as widgets in native platform such as gtk, example of which are Hpane, Vbox, Image,

An element can have an optional namespace, such in the case for html dom where namespace like HTML and SVG, which needs to specified in order to create the DOM element to work on the browser.

The namespace is also needed in attributes where namespace are necessary such as xlink:href where the namespace xlink is needed in order for the linked element in an svg image to work.

Fields

namespace: Option<NS>

namespace of this element, svg elements requires namespace to render correcly in the browser

tag: TAG

the element tag, such as div, a, button

attrs: Vec<Attribute<NS, ATT, VAL>>

attributes for this element

children: Vec<Node<NS, TAG, LEAF, ATT, VAL>>

children elements of this element

self_closing: bool

is the element has a self closing tag

Implementations

impl<NS, TAG, LEAF, ATT, VAL> Element<NS, TAG, LEAF, ATT, VAL> where
    NS: PartialEq + Clone + Debug,
    TAG: PartialEq + Debug,
    LEAF: PartialEq + Clone + Debug,
    ATT: PartialEq + Clone + Debug,
    VAL: PartialEq + Clone + Debug, 

pub fn new(
    namespace: Option<NS>,
    tag: TAG,
    attrs: impl IntoIterator<Item = Attribute<NS, ATT, VAL>>,
    children: impl IntoIterator<Item = Node<NS, TAG, LEAF, ATT, VAL>>,
    self_closing: bool
) -> Self

create a new instance of an element

pub fn add_attributes(
    &mut self,
    attrs: impl IntoIterator<Item = Attribute<NS, ATT, VAL>>
)

add attributes to this element

pub fn add_children(
    &mut self,
    children: impl IntoIterator<Item = Node<NS, TAG, LEAF, ATT, VAL>>
)

add children virtual node to this element

pub fn get_children(&self) -> &[Node<NS, TAG, LEAF, ATT, VAL>]

returns a refernce to the children of this node

pub fn children_mut(&mut self) -> &mut [Node<NS, TAG, LEAF, ATT, VAL>]

returns a mutable reference to the children of this node

pub fn swap_remove_child(
    &mut self,
    index: usize
) -> Node<NS, TAG, LEAF, ATT, VAL>

Removes an child node from this element and returns it.

The removed child is replaced by the last child of the element’s children.

Panics

Panics if index is out of bounds in children

pub fn swap_children(&mut self, a: usize, b: usize)

Swaps the 2 child node in this element

Arguments

• a - The index of the first child node
• b - The index of the second child node

Panics

Panics if both a and b are out of bounds

pub fn take_children(self) -> Vec<Node<NS, TAG, LEAF, ATT, VAL>>

consume self and return the children

pub fn get_attributes(&self) -> &[Attribute<NS, ATT, VAL>]

return a reference to the attribute of this element

pub fn take_attributes(self) -> Vec<Attribute<NS, ATT, VAL>>

consume self and return the attributes

pub fn namespace(&self) -> Option<&NS>

return the namespace of this element

pub fn tag(&self) -> &TAG

return the tag of this element

pub fn take_tag(self) -> TAG

consume self and return the tag of this element

pub fn set_tag(&mut self, tag: TAG)

change the tag of this element

pub fn remove_attribute(&mut self, key: &ATT)

remove the attributes with this key

pub fn set_attributes(
    &mut self,
    attrs: impl IntoIterator<Item = Attribute<NS, ATT, VAL>>
)

remove the existing values of this attribute and add the new values

pub fn merge_attributes(
    &mut self,
    new_attrs: impl IntoIterator<Item = Attribute<NS, ATT, VAL>>
)

merge to existing attributes if it exist

pub fn get_attribute_value(&self, name: &ATT) -> Option<Vec<&VAL>>

return all the attribute values which the name &ATT

Trait Implementations

impl<NS: Clone, TAG: Clone, LEAF: Clone, ATT: Clone, VAL: Clone> Clone for Element<NS, TAG, LEAF, ATT, VAL> where
    NS: PartialEq + Clone + Debug,
    TAG: PartialEq + Debug,
    LEAF: PartialEq + Clone + Debug,
    ATT: PartialEq + Clone + Debug,
    VAL: PartialEq + Clone + Debug, 

fn clone(&self) -> Element<NS, TAG, LEAF, ATT, VAL>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<NS: Debug, TAG: Debug, LEAF: Debug, ATT: Debug, VAL: Debug> Debug for Element<NS, TAG, LEAF, ATT, VAL> where
    NS: PartialEq + Clone + Debug,
    TAG: PartialEq + Debug,
    LEAF: PartialEq + Clone + Debug,
    ATT: PartialEq + Clone + Debug,
    VAL: PartialEq + Clone + Debug, 

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

Formats the value using the given formatter.

impl<NS: Default, TAG: Default, LEAF: Default, ATT: Default, VAL: Default> Default for Element<NS, TAG, LEAF, ATT, VAL> where
    NS: PartialEq + Clone + Debug,
    TAG: PartialEq + Debug,
    LEAF: PartialEq + Clone + Debug,
    ATT: PartialEq + Clone + Debug,
    VAL: PartialEq + Clone + Debug, 

fn default() -> Element<NS, TAG, LEAF, ATT, VAL>

Returns the “default value” for a type.

impl<NS: PartialEq, TAG: PartialEq, LEAF: PartialEq, ATT: PartialEq, VAL: PartialEq> PartialEq<Element<NS, TAG, LEAF, ATT, VAL>> for Element<NS, TAG, LEAF, ATT, VAL> where
    NS: PartialEq + Clone + Debug,
    TAG: PartialEq + Debug,
    LEAF: PartialEq + Clone + Debug,
    ATT: PartialEq + Clone + Debug,
    VAL: PartialEq + Clone + Debug, 

fn eq(&self, other: &Element<NS, TAG, LEAF, ATT, VAL>) -> bool

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

fn ne(&self, other: &Element<NS, TAG, LEAF, ATT, VAL>) -> bool

This method tests for !=.

impl<NS, TAG, LEAF, ATT, VAL> StructuralPartialEq for Element<NS, TAG, LEAF, ATT, VAL> where
    NS: PartialEq + Clone + Debug,
    TAG: PartialEq + Debug,
    LEAF: PartialEq + Clone + Debug,
    ATT: PartialEq + Clone + Debug,
    VAL: PartialEq + Clone + Debug,