Struct HighlightedText 

pub struct HighlightedText<S> { /* private fields */ }

Represents text which was highlighted by the TextHighlighter.

Display implementations come in the form of Self::display_plain, Self::display_subs and Self::display_raw.

Implementations

impl<S> HighlightedText<S>

pub fn raw(&self) -> &S

Grab a handle to the raw data.

pub fn raw_mut(&mut self) -> &mut S

Grab a mutable handle to the underlying data.

pub fn markers(&self) -> [char; 2]

pub fn map<T>(self, f: impl FnOnce(S) -> T) -> HighlightedText<T>

Swap the underlying string type, keeping the highlighter (e.g. line.map(str::to_owned)).

impl<S: AsRef<str>> HighlightedText<S>

pub fn ranges(&self) -> impl Iterator<Item = Range<usize>> + '_

pub fn pieces(&self) -> impl Iterator<Item = Piece<'_>> + '_

Walk the text as a stream of marker-free chunks: Piece::Text for unhighlighted runs and Piece::Match for each highlighted span.

Concatenating every chunk yields the same string as Self::display_plain, and the Piece::Match chunks are exactly the spans Self::ranges reports. Empty chunks are skipped.

pub fn has_match(&self) -> bool

Whether any highlighted span is present.

pub fn lines(&self) -> impl Iterator<Item = HighlightedText<&str>> + '_

Each line as its own highlighted text. A match never spans a newline, so every span stays within one line.

pub fn to_plain(&self) -> Plain<'_>

The marker-free text together with the byte range of every match within that text – unlike Self::ranges, whose offsets index the raw, marker-bearing string.

pub fn display_plain(&self) -> impl Display + '_

Display the highlighted text, stripping away the highlight markers.

pub fn display_subs(&self, subs: [char; 2]) -> impl Display + '_

Display the highlighted text, replacing highlighted markers with subs.

pub fn display_raw(&self) -> impl Display + '_

Display the highlighted text as-is, including markers.

Trait Implementations

impl<S: AsRef<str>> AsRef<str> for HighlightedText<S>

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<S: Clone> Clone for HighlightedText<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Copy> Copy for HighlightedText<S>

impl<S: AsRef<str>> Debug for HighlightedText<S>

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

Formats the value using the given formatter.