Struct SearchState 

pub struct SearchState { /* private fields */ }

A search and its results.

The cursor is an index into matches, so stepping is trivial and wraps. None means “no match is current yet” — the state right after a query changes, before the caller has picked a starting point.

Implementations

impl SearchState

pub fn new() -> SearchState

pub fn needle(&self) -> &str

pub fn case_sensitive(&self) -> bool

pub fn is_active(&self) -> bool

pub fn matches(&self) -> &[Match]

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn ordinal(&self) -> Option<usize>

1-based position of the current match, for a “3 of 17” readout.

pub fn current(&self) -> Option<Match>

pub fn current_index(&self) -> Option<usize>

pub fn is_current(&self, m: &Match) -> bool

Is this exact occurrence the current one?

Compared by value rather than by index so the renderer doesn’t need to know where in the list it is.

pub fn clear(&mut self)

pub fn set_results( &mut self, needle: &str, case_sensitive: bool, matches: Vec<Match>, )

Install a fresh result set for needle.

pub fn seek_from( &mut self, order: impl Fn(MessageId) -> Option<usize>, from_row: usize, )

Point the cursor at the first match at or after message, so opening the find bar starts from what is on screen rather than from the top of a long scrollback.

Falls back to the last match when everything is above the viewport, which is the useful direction: scrollback grows downward and the interesting end is the recent one.

pub fn step(&mut self, dir: i32) -> Option<Match>

Step the cursor. dir > 0 forward, dir < 0 back; both wrap.

With no current match, a forward step selects the first and a backward step the last, so both keys do something useful the first time they are pressed.

Trait Implementations

impl Clone for SearchState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchState

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

Formats the value using the given formatter.

impl Default for SearchState

fn default() -> Self

Returns the “default value” for a type.