Struct FindSession 

pub struct FindSession { /* private fields */ }

What a find over one Findable has found: how many matches, which is current, and the query and content they were found for. The FindBar keeps one, and so does the window bar’s search (crate::widget::WindowSearch): one engine, whatever draws the field.

Implementations

impl FindSession

pub fn matches(&self) -> usize

How many matches the last find found.

pub fn position(&self) -> Option<(usize, usize)>

(current, total), 1-based current; None with no current match.

pub fn set_results(&mut self, total: usize, current: Option<usize>)

The results of a view whose engine finds on its own: total matches, current the 0-based one shown.

pub fn is_stale(&self, query: &str, options: FindOptions) -> bool

Whether query under options is not what the matches were found for.

pub fn content_moved(&self, target: &dyn Findable) -> bool

Whether the content under the find changed since it last ran.

pub fn search( &mut self, target: &mut dyn Findable, query: &str, options: FindOptions, keep: Option<usize>, )

Find query again and show the match nearest keep (the first with None): the query or an option changed.

pub fn refresh( &mut self, target: &mut dyn Findable, query: &str, options: FindOptions, )

Find query again without moving the view, keeping the current match: the content changed under the find. After a replacement the view applied later, the match now current is shown as after any replacement.

pub fn replace( &mut self, target: &mut dyn Findable, query: &str, options: FindOptions, with: &str, all: bool, ) -> bool

Replace the current match of query under options with with, or every match (all), then show the match that is current after it: the one that followed the replaced match. A view that applies the edit later is found again once its content moved. Returns whether the view took the replacement.

pub fn reveal_current(&self, target: &mut dyn Findable) -> bool

Show the current match again (what covers the view changed); whether there was one to show.

pub fn step(&mut self, target: &mut dyn Findable, forward: bool)

Make the next (or previous) match current, wrapping, and show it.

pub fn clear(&mut self, target: &mut dyn Findable)

The find ended: the view stops painting matches.

pub fn forget(&mut self)

Forget the matches without telling a view (it is gone).

Trait Implementations

impl Clone for FindSession

fn clone(&self) -> FindSession

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FindSession

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

Formats the value using the given formatter.

impl Default for FindSession

fn default() -> FindSession

Returns the “default value” for a type.

impl PartialEq for FindSession

fn eq(&self, other: &FindSession) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FindSession

impl StructuralPartialEq for FindSession