Struct SearchDriver 

pub struct SearchDriver { /* private fields */ }

The find engine behind a window’s search, run where the app’s widgets are: by the window for an app in its process, by the app’s own runtime for an app in a process of its own. It finds or narrows when the query changed, follows the content when it changed under the search, steps, and stops when the search closed.

Implementations

impl SearchDriver

pub fn open(&mut self, in_place: InPlace)

Start a search on what the app offers: the query runs afresh on what it shows now.

pub fn in_place(&self) -> InPlace

What the search acts on; InPlace::Nothing while none is open.

pub fn matches(&self) -> usize

How many matches a document’s search found.

pub fn abilities(&self) -> FindAbilities

What the document’s find offers beyond matching, as last driven.

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

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

pub fn count(&self) -> Option<FilterCount>

What the field’s counter shows: the current match of all of them in a document, the rows shown of all rows in a list; none before anything is typed.

pub fn forget(&mut self)

Forget what was found without telling the app (it went away).

pub fn set_cover(&mut self, cover: Option<Rect>)

What of the document the search’s options cover now, in the app’s coordinates (None: nothing). The next drive tells the document, which shows the current match clear of it.

pub fn take_adopted(&mut self) -> Option<(String, FindOptions)>

The query and options of a find the document ran on its own (Findable::take_own_find) that the last drive took over: the field shows that query and drives with it from now on.

pub fn drive( &mut self, root: &mut dyn Widget, query: &str, options: FindOptions, step: Option<bool>, finishing: bool, ) -> bool

Carry query under options to the app’s root, step when asked, or stop when finishing (after which the driver is closed). Returns whether anything the app shows changed.

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

Replace the current match of the document’s search for query under options with with, or every match (all), and find again, keeping the place. Returns whether the document changed.

Trait Implementations

impl Debug for SearchDriver

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

Formats the value using the given formatter.

impl Default for SearchDriver

fn default() -> SearchDriver

Returns the “default value” for a type.