Struct FindQuery 

#[non_exhaustive]
pub struct FindQuery {
    pub text: String,
    pub case_sensitive: bool,
    pub whole_word: bool,
    pub regex: bool,
}

An active find query: the pattern plus its option flags.

PartialEq so the Document surface can no-op an unchanged query without re-scanning — the flags are part of that identity, because each one changes what matches, not how it is displayed.

The flags pick the matcher: plain text takes the literal byte scan; whole_word or regex take the line-scoped engine.

#[non_exhaustive] so a future option can be added without a breaking change: outside this crate, build one with FindQuery::new (a plain literal query) and set the options you want on its public fields, rather than a struct literal.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: String

The text to find — a literal, or a regular expression when regex is set. Empty means “no matches” (never match-all).

case_sensitive: bool

When false, a/A fold together. Case folding is ASCII-only in the literal matcher, and Unicode-aware in the regex one.

whole_word: bool

Match only whole words — the ab| option. A match must be bounded by non-word characters (or the edges of its line) on both sides.

regex: bool

Treat text as a regular expression — the .* option.

Matching is line-scoped: the engine is fed one line at a time, so a pattern can never match across a newline. An invalid pattern is not an error state — it is what every prefix of a pattern being typed looks like — so it simply yields no matches, and FindState::pattern_error carries the reason for the bar to show.

Implementations

impl FindQuery

pub fn new(text: impl Into<String>) -> Self

A plain literal query for text — every option off (case-insensitive, not whole-word, not regex). The common case; set the public option fields on the returned value to change it.

Trait Implementations

impl Clone for FindQuery

fn clone(&self) -> FindQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FindQuery

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

Formats the value using the given formatter.

impl Default for FindQuery

fn default() -> FindQuery

Returns the “default value” for a type.

impl Eq for FindQuery

impl PartialEq for FindQuery

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FindQuery