Struct matrix_sdk::ruma::html::Html
pub struct Html { /* private fields */ }Expand description
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
impl Html
pub fn parse(string: &str) -> Html
pub fn parse(string: &str) -> Html
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(&mut self)
pub fn sanitize(&mut 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(&mut self, config: SanitizerConfig)
pub fn sanitize_with(&mut self, config: SanitizerConfig)
Sanitize this HTML according to the given configuration.
pub fn has_children(&self) -> bool
pub fn has_children(&self) -> bool
Whether the root node of the HTML has children.
pub fn first_child(&self) -> Option<NodeRef<'_>>
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<'_>>
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.
Trait Implementations§
§impl TreeSink for Html
impl TreeSink for Html
§type Handle = usize
type Handle = usize
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.§fn finish(self) -> <Html as TreeSink>::Output
fn finish(self) -> <Html as TreeSink>::Output
Consume this sink and return the overall result of parsing. Read more
§fn parse_error(&mut self, msg: Cow<'static, str>)
fn parse_error(&mut self, msg: Cow<'static, str>)
Signal a parse error.
§fn get_document(&mut self) -> <Html as TreeSink>::Handle
fn get_document(&mut self) -> <Html as TreeSink>::Handle
Get a handle to the
Document node.§fn elem_name<'a>(
&'a self,
target: &'a <Html as TreeSink>::Handle
) -> ExpandedName<'a>
fn elem_name<'a>( &'a self, target: &'a <Html as TreeSink>::Handle ) -> ExpandedName<'a>
What is the name of this element? Read more
§fn create_element(
&mut self,
name: QualName,
attrs: Vec<Attribute>,
_flags: ElementFlags
) -> <Html as TreeSink>::Handle
fn create_element( &mut self, name: QualName, attrs: Vec<Attribute>, _flags: ElementFlags ) -> <Html as TreeSink>::Handle
Create an element. Read more
§fn create_comment(&mut self, _text: Tendril<UTF8>) -> <Html as TreeSink>::Handle
fn create_comment(&mut self, _text: Tendril<UTF8>) -> <Html as TreeSink>::Handle
Create a comment node.
§fn create_pi(
&mut self,
_target: Tendril<UTF8>,
_data: Tendril<UTF8>
) -> <Html as TreeSink>::Handle
fn create_pi( &mut self, _target: Tendril<UTF8>, _data: Tendril<UTF8> ) -> <Html as TreeSink>::Handle
Create a Processing Instruction node.
§fn append(
&mut self,
parent: &<Html as TreeSink>::Handle,
child: NodeOrText<<Html as TreeSink>::Handle>
)
fn append( &mut self, parent: &<Html as TreeSink>::Handle, child: NodeOrText<<Html as TreeSink>::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. Read more
§fn append_based_on_parent_node(
&mut self,
element: &<Html as TreeSink>::Handle,
prev_element: &<Html as TreeSink>::Handle,
child: NodeOrText<<Html as TreeSink>::Handle>
)
fn append_based_on_parent_node( &mut self, element: &<Html as TreeSink>::Handle, prev_element: &<Html as TreeSink>::Handle, child: NodeOrText<<Html as TreeSink>::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(
&mut self,
_name: Tendril<UTF8>,
_public_id: Tendril<UTF8>,
_system_id: Tendril<UTF8>
)
fn append_doctype_to_document( &mut self, _name: Tendril<UTF8>, _public_id: Tendril<UTF8>, _system_id: Tendril<UTF8> )
Append a
DOCTYPE element to the Document node.§fn get_template_contents(
&mut self,
target: &<Html as TreeSink>::Handle
) -> <Html as TreeSink>::Handle
fn get_template_contents( &mut self, target: &<Html as TreeSink>::Handle ) -> <Html as TreeSink>::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: &<Html as TreeSink>::Handle,
y: &<Html as TreeSink>::Handle
) -> bool
fn same_node( &self, x: &<Html as TreeSink>::Handle, y: &<Html as TreeSink>::Handle ) -> bool
Do two handles refer to the same node?
§fn set_quirks_mode(&mut self, _mode: QuirksMode)
fn set_quirks_mode(&mut self, _mode: QuirksMode)
Set the document’s quirks mode.
§fn append_before_sibling(
&mut self,
sibling: &<Html as TreeSink>::Handle,
new_node: NodeOrText<<Html as TreeSink>::Handle>
)
fn append_before_sibling( &mut self, sibling: &<Html as TreeSink>::Handle, new_node: NodeOrText<<Html as TreeSink>::Handle> )
Append a node as the sibling immediately before the given node. Read more
§fn add_attrs_if_missing(
&mut self,
target: &<Html as TreeSink>::Handle,
attrs: Vec<Attribute>
)
fn add_attrs_if_missing( &mut self, target: &<Html as TreeSink>::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(&mut self, target: &<Html as TreeSink>::Handle)
fn remove_from_parent(&mut self, target: &<Html as TreeSink>::Handle)
Detach the given node from its parent.
§fn reparent_children(
&mut self,
node: &<Html as TreeSink>::Handle,
new_parent: &<Html as TreeSink>::Handle
)
fn reparent_children( &mut self, node: &<Html as TreeSink>::Handle, new_parent: &<Html as TreeSink>::Handle )
Remove all the children from node and append them to new_parent.
§fn mark_script_already_started(&mut self, _node: &Self::Handle)
fn mark_script_already_started(&mut self, _node: &Self::Handle)
Mark a HTML
<script> as “already started”.§fn pop(&mut self, _node: &Self::Handle)
fn pop(&mut self, _node: &Self::Handle)
Indicate that a node was popped off the stack of open elements.
§fn associate_with_form(
&mut self,
_target: &Self::Handle,
_form: &Self::Handle,
_nodes: (&Self::Handle, Option<&Self::Handle>)
)
fn associate_with_form( &mut 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
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(&mut self, _line_number: u64)
fn set_current_line(&mut self, _line_number: u64)
Called whenever the line number changes.
§fn complete_script(&mut self, _node: &Self::Handle) -> NextParserState
fn complete_script(&mut self, _node: &Self::Handle) -> NextParserState
Indicate that a
script element is complete.Auto Trait Implementations§
impl !RefUnwindSafe for Html
impl !Send for Html
impl !Sync for Html
impl Unpin for Html
impl !UnwindSafe for Html
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> CompatExt for T
impl<T> CompatExt for T
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
Read this value from the supplied reader. Same as
ReadEndian::read_from_little_endian().