Struct ruma_html::Html

pub struct Html { /* private fields */ }

An HTML fragment.

To get the serialized HTML, use its Display implementation. Due to the fact that the HTML is parsed, note that malformed HTML and comments will be stripped from the output.

Implementations

impl Html

pub fn parse(string: &str) -> Self

Construct a new Html by parsing the given string.

This is infallible, any error encountered while parsing the HTML is logged with tracing::debug!.

pub fn sanitize(&self)

Sanitize this HTML according to the Matrix specification.

This is equivalent to calling Self::sanitize_with() with a config value of SanitizerConfig::compat().remove_reply_fallback().

pub fn sanitize_with(&self, config: &SanitizerConfig)

Sanitize this HTML according to the given configuration.

pub fn has_children(&self) -> bool

Whether the root node of the HTML has children.

pub fn first_child(&self) -> Option<NodeRef>

The first child node of the root node of the HTML.

Returns None if the root node has no children.

pub fn last_child(&self) -> Option<NodeRef>

The last child node of the root node of the HTML .

Returns None if the root node has no children.

pub fn children(&self) -> Children

Iterate through the children of the root node of the HTML.

Trait Implementations

impl Debug for Html

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

Formats the value using the given formatter.

impl Default for Html

fn default() -> Self

Returns the “default value” for a type.

impl Display for Html

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

Formats the value using the given formatter.

impl Serialize for Html

fn serialize<S>( &self, serializer: &mut S, traversal_scope: TraversalScope, ) -> Result<()>

where S: Serializer,

Take the serializer and call its methods to serialize this type. The type will dictate which methods are called and with what parameters.

impl TreeSink for Html

type Handle = NodeRef

Handle is a reference to a DOM node. The tree builder requires that a Handle implements Clone to get another reference to the same node.

type Output = Html

The overall result of parsing.

type ElemName<'a> = ExpandedName<'a>

fn finish(self) -> Self::Output

Consume this sink and return the overall result of parsing.

fn parse_error(&self, msg: Cow<'static, str>)

Signal a parse error.

fn get_document(&self) -> Self::Handle

Get a handle to the Document node.

fn elem_name<'a>(&'a self, target: &'a Self::Handle) -> ExpandedName<'a>

What is the name of this element?

fn create_element( &self, name: QualName, attrs: Vec<Attribute>, _flags: ElementFlags, ) -> Self::Handle

Create an element.

fn create_comment(&self, _text: StrTendril) -> Self::Handle

Create a comment node.

fn create_pi(&self, _target: StrTendril, _data: StrTendril) -> Self::Handle

Create a Processing Instruction node.

fn append(&self, parent: &Self::Handle, child: NodeOrText<Self::Handle>)

Append a node as the last child of the given node. If this would produce adjacent sibling text nodes, it should concatenate the text instead.

fn append_based_on_parent_node( &self, element: &Self::Handle, prev_element: &Self::Handle, child: NodeOrText<Self::Handle>, )

When the insertion point is decided by the existence of a parent node of the element, we consider both possibilities and send the element which will be used if a parent node exists, along with the element to be used if there isn’t one.

fn append_doctype_to_document( &self, _name: StrTendril, _public_id: StrTendril, _system_id: StrTendril, )

Append a DOCTYPE element to the Document node.

fn get_template_contents(&self, target: &Self::Handle) -> Self::Handle

Get a handle to a template’s template contents. The tree builder promises this will never be called with something else than a template element.

fn same_node(&self, x: &Self::Handle, y: &Self::Handle) -> bool

Do two handles refer to the same node?

fn set_quirks_mode(&self, _mode: QuirksMode)

Set the document’s quirks mode.

fn append_before_sibling( &self, sibling: &Self::Handle, new_node: NodeOrText<Self::Handle>, )

Append a node as the sibling immediately before the given node.

fn add_attrs_if_missing(&self, target: &Self::Handle, attrs: Vec<Attribute>)

Add each attribute to the given element, if no attribute with that name already exists. The tree builder promises this will never be called with something else than an element.

fn remove_from_parent(&self, target: &Self::Handle)

Detach the given node from its parent.

fn reparent_children(&self, node: &Self::Handle, new_parent: &Self::Handle)

Remove all the children from node and append them to new_parent.

fn mark_script_already_started(&self, _node: &Self::Handle)

Mark a HTML <script> as “already started”.

fn pop(&self, _node: &Self::Handle)

Indicate that a node was popped off the stack of open elements.

fn associate_with_form( &self, _target: &Self::Handle, _form: &Self::Handle, _nodes: (&Self::Handle, Option<&Self::Handle>), )

Associate the given form-associatable element with the form element

fn is_mathml_annotation_xml_integration_point( &self, _handle: &Self::Handle, ) -> bool

Returns true if the adjusted current node is an HTML integration point and the token is a start tag.

fn set_current_line(&self, _line_number: u64)

Called whenever the line number changes.

fn complete_script(&self, _node: &Self::Handle) -> NextParserState

Indicate that a script element is complete.