Struct HighlightedText 

pub struct HighlightedText { /* private fields */ }

A run of text with some of it marked.

The current mark is a different treatment from the rest, not a stronger one: “which hit am I on” and “where are the other hits” are two questions, and one shade of the same colour answers neither clearly.

Implementations

impl HighlightedText

pub fn new(text: impl Into<SharedString>) -> Self

pub fn id(self, ident: impl Into<Ident>) -> Self

Publishes a node under this id. Without one nothing is published, the way a decorative Badge publishes nothing.

pub fn hits(self, hits: impl IntoIterator<Item = Range<usize>>) -> Self

The ranges to mark, in byte offsets into the text this was given.

pub fn current(self, index: usize) -> Self

Which hit, by index into HighlightedText::hits, is the current one.

pub fn monospace(self, monospace: bool) -> Self

pub fn published_hits(&self) -> usize

How many of the given ranges name text this string actually holds.

A caller whose offsets are wrong gets a smaller number than it handed in, which is how a broken boundary is noticed rather than guessed at.

Trait Implementations

impl Debug for HighlightedText

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

Formats the value using the given formatter.

impl IntoElement for HighlightedText

type Element = ViewElement<HighlightedText>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for HighlightedText

fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.