Struct Search 

pub struct Search { /* private fields */ }

A comprehensive search engine supporting regex queries and case insensitivity.

Implementations

impl Search

pub fn new() -> Self

Creates a new inactive search container.

pub fn is_match(&self, text: &str) -> bool

Evaluates if the provided text satisfies the current search filter.

pub fn set_text(&mut self, text: impl Into<String>)

Updates the raw query string and regenerates the matcher state.

pub fn set_options(&mut self, options: SearchOptions)

Replaces the active search options.

pub fn toggle_option(&mut self, option: SearchOptions)

Toggles a specific search behavior option.

pub fn open(&mut self)

Activates the search matching engine.

pub fn clear(&mut self)

Clears the query and deactivates matching.

pub fn edit_text(&mut self, f: impl FnOnce(&mut String) -> bool) -> bool

Permits safe mutability of the search query, rebuilding state on changes.

pub fn text(&self) -> &str

Exposes the current raw query string.

pub const fn options(&self) -> SearchOptions

Exposes the current search configuration options.

pub const fn is_active(&self) -> bool

Returns whether the search is active.

pub fn error_message(&self) -> Option<&str>

Exposes localized error messages if a regex query fails compilation.

Trait Implementations

impl Clone for Search

fn clone(&self) -> Search

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Search

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

Formats the value using the given formatter.

impl Default for Search

fn default() -> Search

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Search

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Search

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.