Enum sauron_vdom::Node

pub enum Node<T, ATT, EVENT, MSG> where
    MSG: 'static,
    EVENT: 'static,
    ATT: Clone,  {
    Element(Element<T, ATT, EVENT, MSG>),
    Text(Text),
}

This is the core data structure of the library. Any tree can be represented by Node. The T is generic instead of just using plain &'static str in order for this library to be used not only in html based widget but can also be used to represent native GUI widgets in various platforms.

Note: Clone is necessary for the aesthetics in the construction of node through series of function calls. Without Clone, the user code would look like these:

    div(&[class("some-class"), &[text("Some text")])

as compared to

    div([class("some-class"), [text("some text)])

Cloning is only done once, and happens when constructing the views into a node tree. Cloning also allows flexibility such as adding more children into an existing node/element.

Variants

Element(Element<T, ATT, EVENT, MSG>)

Element variant of a virtual node

Text(Text)

Text variant of a virtual node

Implementations

impl<T, ATT, EVENT, MSG> Node<T, ATT, EVENT, MSG> where
    EVENT: 'static,
    MSG: 'static,
    ATT: PartialEq + Ord + ToString + Clone, 

pub fn map_msg<F, MSG2>(self, func: F) -> Node<T, ATT, EVENT, MSG2> where
    F: Fn(MSG) -> MSG2 + 'static,
    MSG2: 'static, 

map the msg of callback of this element node

pub fn take_element(self) -> Option<Element<T, ATT, EVENT, MSG>>

consume the element

pub fn as_element_mut(&mut self) -> Option<&mut Element<T, ATT, EVENT, MSG>>

Get a mutable reference to the element, if this node is an element node

pub fn as_element_ref(&self) -> Option<&Element<T, ATT, EVENT, MSG>>

returns a reference to the element if this is an element node

pub fn add_children(self, children: Vec<Node<T, ATT, EVENT, MSG>>) -> Self

Append children to this element

pub fn add_attributes(self, attributes: Vec<Attribute<ATT, EVENT, MSG>>) -> Self

add attributes to the node and returns itself this is used in view building

pub fn add_attributes_ref_mut(
    &mut self,
    attributes: Vec<Attribute<ATT, EVENT, MSG>>
)

add attributes using a mutable reference to self

pub fn get_attributes(&self) -> Vec<Attribute<ATT, EVENT, MSG>>

get the attributes of this node

pub fn tag(&self) -> Option<&T>

returns the tag of this node if it is an element

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

returns the text content if it is a text node

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

returns the text if this node has only one child and is a text. includes: h1, h2..h6, p,

pub fn get_children(&self) -> Option<&[Node<T, ATT, EVENT, MSG>]>

return the children of this node if it is an element

Trait Implementations

impl<T: Clone, ATT: Clone, EVENT: Clone, MSG: Clone> Clone for Node<T, ATT, EVENT, MSG> where
    MSG: 'static,
    EVENT: 'static,
    ATT: Clone, 

fn clone(&self) -> Node<T, ATT, EVENT, MSG>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, ATT: Debug, EVENT: Debug, MSG: Debug> Debug for Node<T, ATT, EVENT, MSG> where
    MSG: 'static,
    EVENT: 'static,
    ATT: Clone, 

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

Formats the value using the given formatter.

impl<T, ATT, EVENT, MSG> Display for Node<T, ATT, EVENT, MSG> where
    T: ToString,
    EVENT: 'static,
    MSG: 'static,
    ATT: PartialEq + Ord + ToString + Clone, 

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

Formats the value using the given formatter.

impl<T, ATT, EVENT, MSG> From<Element<T, ATT, EVENT, MSG>> for Node<T, ATT, EVENT, MSG> where
    ATT: Clone, 

fn from(v: Element<T, ATT, EVENT, MSG>) -> Self

Performs the conversion.

impl<T: PartialEq, ATT: PartialEq, EVENT: PartialEq, MSG: PartialEq> PartialEq<Node<T, ATT, EVENT, MSG>> for Node<T, ATT, EVENT, MSG> where
    MSG: 'static,
    EVENT: 'static,
    ATT: Clone, 

fn eq(&self, other: &Node<T, ATT, EVENT, MSG>) -> bool

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

fn ne(&self, other: &Node<T, ATT, EVENT, MSG>) -> bool

This method tests for !=.

impl<T, ATT, EVENT, MSG> StructuralPartialEq for Node<T, ATT, EVENT, MSG> where
    MSG: 'static,
    EVENT: 'static,
    ATT: Clone,