Struct InlineHtmlBuilder

pub(super) struct InlineHtmlBuilder<'a> {
    single_line: bool,
    ellipsis: bool,
    mentions: MentionsMode<'a>,
    inner: String,
    truncated: bool,
}

Helper type to construct a Pango-compatible string from inline HTML nodes.

Fields

single_line: bool

Whether this string should be on a single line.

ellipsis: bool

Whether to append an ellipsis at the end of the string.

mentions: MentionsMode<'a>

The mentions detection setting and results.

inner: String

The inner string.

truncated: bool

Whether this string was truncated because at the first newline.

Implementations

impl<'a> InlineHtmlBuilder<'a>

pub(super) fn new(single_line: bool, ellipsis: bool) -> Self

Constructs a new inline HTML string builder for the given room.

If single_line is set to true, the string will be ellipsized at the first line break.

If ellipsis is set to true, and ellipsis will be added at the end of the string.

pub(super) fn detect_mentions( self, room: &'a Room, detect_at_room: bool, ) -> Self

Enable mentions detection in the given room.

If detect_at_room is true, it will also try to detect @room mentions.

pub(super) fn append_emote_with_name(self, name: &mut Option<&str>) -> Self

Append and consume the given sender name for an emote, if it is set.

pub(super) fn build(self) -> (String, Option<Vec<Pill>>)

Export the Pango-compatible string and the Pills that were constructed, if any.

pub(super) fn build_with_nodes( self, nodes: impl IntoIterator<Item = NodeRef>, ) -> (String, Option<Vec<Pill>>)

Construct the string with the given inline nodes by converting them to Pango markup.

Returns the Pango-compatible string and the Pills that were constructed, if any.

pub(super) fn build_with_nodes_text( self, nodes: impl IntoIterator<Item = NodeRef>, ) -> String

Construct the string by traversing the nodes an returning only the text it contains.

Node that markup contained in the text is not escaped and newlines are not removed.

fn append_node(&mut self, node: &NodeRef, should_linkify: bool)

Append the given inline node by converting it to Pango markup.

fn append_nodes( &mut self, nodes: impl IntoIterator<Item = NodeRef>, should_linkify: bool, )

Append the given inline nodes, converted to Pango markup.

fn append_tags_and_children( &mut self, tag_name: &str, children: Children, should_linkify: bool, )

Append the given inline children, converted to Pango markup, surrounded by tags with the given name.

fn append_link_opening_tag_from_anchor_uri(&mut self, uri: &AnchorUri) -> bool

Append the opening Pango markup link tag of the given anchor URI.

The URI is also used as a title, so users can preview the link on hover.

Returns true if the opening tag was successfully constructed.

fn append_span( &mut self, span: &SpanData, children: Children, should_linkify: bool, )

Append the span with the given data and inline children as Pango Markup.

Whether we are an inside an anchor or not decides if we try to linkify the text contained in the children nodes.

fn append_nodes_text(&mut self, nodes: impl IntoIterator<Item = NodeRef>)

Append the text contained in the nodes to the string.

Returns true if the text was ellipsized.

Trait Implementations

impl<'a> Debug for InlineHtmlBuilder<'a>

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

Formats the value using the given formatter.