Struct sycamore::generic_node::ssr_node::SsrNode

pub struct SsrNode(_);

Rendering backend for Server Side Rendering, aka. SSR.

This API requires the following crate features to be activated: ssr

Implementations

impl SsrNode

pub fn unwrap_element(&self) -> &RefCell<Element>

pub fn unwrap_text(&self) -> &RefCell<Text>

pub fn raw_text_node(html: &str) -> Self

Create a new raw text node.

Do not pass unsanitized user input to this function. When the node is rendered, no escaping will be performed which might lead to a XSS (Cross Site Scripting) attack.

Trait Implementations

impl Clone for SsrNode

fn clone(&self) -> SsrNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SsrNode

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

Formats the value using the given formatter.

impl GenericNode for SsrNode

fn element(tag: &str) -> Self

Create a new element node.

fn text_node(text: &str) -> Self

Create a new text node.

fn marker() -> Self

Create a marker (dummy) node. For DomNode, this is implemented by creating an empty comment node. This is used, for example, in Keyed and Indexed for scenarios where you want to push a new item to the end of the list. If the list is empty, a dummy node is needed to store the position of the component.

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

Sets an attribute on a node.

fn remove_attribute(&self, name: &str)

Removes an attribute on a node.

fn set_class_name(&self, value: &str)

Sets the class attribute on a node. This should have the same outcome as calling set_attribute("class", value). For DomNode, this sets the className property directly which is about 2x faster (on Chrome).

fn set_property(&self, _name: &str, _value: &JsValue)

Sets a property on a node.

fn remove_property(&self, _name: &str)

Removes a property on a node.

fn append_child(&self, child: &Self)

Appends a child to the node’s children.

fn first_child(&self) -> Option<Self>

Get the first child of the node.

fn insert_child_before(&self, new_node: &Self, reference_node: Option<&Self>)

Insert a new child node to this node’s children. If reference_node is Some, the child will be inserted before the reference node. Else if None, the child will be inserted at the end.

fn remove_child(&self, child: &Self)

Remove a child node from this node’s children.

fn replace_child(&self, old: &Self, new: &Self)

Replace a child node from this node’s children with a new child node.

fn insert_sibling_before(&self, child: &Self)

Insert a new node before this node.

fn parent_node(&self) -> Option<Self>

Returns the parent node, or None if detached.

fn next_sibling(&self) -> Option<Self>

Returns the next sibling, or None if this node is the last sibling.

fn remove_self(&self)

Remove this node from the tree.

fn event(&self, _name: &str, _handler: Box<EventHandler>)

Add a EventHandler to the event name.

fn update_inner_text(&self, text: &str)

Update inner text of the node. If the node has elements, all the elements are replaced with a new text node.

fn dangerously_set_inner_html(&self, html: &str)

Updates the inner html of the node. The html will not be parsed in non-browser environments. This means that accessing methods such as first_child will return None.

fn clone_node(&self) -> Self

Create a deep clone of the node.

impl Hash for SsrNode

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 PartialEq<SsrNode> for SsrNode

fn eq(&self, other: &Self) -> 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 !=.

impl Eq for SsrNode