Struct SearchOptions 

pub struct SearchOptions {
    pub query: String,
    pub domains: SearchDomain,
    pub case_sensitive: bool,
    pub include_private: bool,
    pub expand_containers: bool,
}

Options that control how a crate search should be performed.

Fields

query: String

Raw user query to evaluate.

domains: SearchDomain

Domains to search across; defaults to SearchDomain::default.

case_sensitive: bool

Whether matching should respect letter casing.

include_private: bool

Whether to include private or crate-private items.

expand_containers: bool

Whether matched container items should expand to include their children.

Implementations

impl SearchOptions

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

Create a new options struct with the provided query string.

pub fn ensure_domains(&mut self)

Ensure the options have at least one domain selected.

Trait Implementations

impl Clone for SearchOptions

fn clone(&self) -> SearchOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchOptions

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

Formats the value using the given formatter.