Struct FindSession 

pub struct FindSession { /* private fields */ }

A search-highlight layer: the matches of a query, as a document range session, with the current match distinguished.

Implementations

impl FindSession

pub fn new( doc: &TextDocument, current_format: HighlightFormat, other_format: HighlightFormat, ) -> Self

Attach a fresh, empty find session to doc. current_format styles the current match (e.g. the editor selection colour); other_format styles the rest (e.g. a subtle accent). Both should be paint-only (background / underline) so the highlight stays out of the accessibility tree — a screen-reader user navigates matches by count, not by colour.

pub fn session_id(&self) -> SessionId

The document session this layer owns — put it in a view’s HighlightMask to render it there.

pub fn set_query(&mut self, query: &str, options: &FindOptions)

Re-run query and highlight every match; the first becomes current. An empty query clears the highlighting.

pub fn set_current(&mut self, index: Option<usize>) -> Option<FindMatch>

Say which of this document’s matches the reader is standing on, or None for “none of them” — the state a find spanning several documents needs for every document but the one holding the cursor. Returns the new current match.

An index past the end is clamped to the last match, and any index at all on an empty match set is None: a caller stepping into a document it has just re-run cannot be asked to know how many matches it turned out to have.

pub fn refresh_if_stale(&mut self) -> bool

Re-derive the matches for the stored query if an edit has staled them since the last run. Returns true if it re-derived (so the caller can request a repaint). Cheap to call every frame: a no-op when nothing has changed.

The current-match index is clamped, not reset — an edit should not throw away where the writer was in the match list, only re-locate the matches. A document that had no current match still has none: the reader is standing somewhere else.

pub fn match_count(&self) -> usize

How many matches the last query found.

pub fn current_index(&self) -> usize

The current match’s 0-based index (0 when the reader is not standing on one).

pub fn current_match(&self) -> Option<FindMatch>

The current match, if the reader is standing on one of this document’s.

pub fn next_match(&mut self) -> Option<FindMatch>

Advance to the next match, wrapping past the end, and return it. None if there are no matches. From “no current match” it lands on the first — which is what stepping into this document from the one above it means.

pub fn prev_match(&mut self) -> Option<FindMatch>

Step to the previous match, wrapping past the start, and return it. From “no current match” it lands on the last, the mirror of next_match: stepping backwards into a document arrives at its end.

pub fn clear(&mut self)

Clear all highlighting (the query went away, or the banner closed).

Trait Implementations

impl Drop for FindSession

fn drop(&mut self)

Retire the session so a closed find banner leaves no highlight layer behind on the shared document.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.