Struct GlobalSearch 

pub struct GlobalSearch { /* private fields */ }

Configuration and results for a global search operation.

This struct holds all parameters needed to perform a search across a pack, as well as the results from the most recent search operation.

Example

let mut search = GlobalSearch::default();
search.set_pattern("cavalry".to_string());
search.set_case_sensitive(false);
search.search(&mut pack, &schema, &dependencies);

Implementations

impl GlobalSearch

pub fn pattern(&self) -> &String

The text pattern or regex to search for.

pub fn replace_text(&self) -> &String

Text to use for replacements.

This is always a literal string - regex capture groups are not supported in the replacement text.

pub fn case_sensitive(&self) -> &bool

Whether the search should be case-sensitive.

When false, “Cavalry” will match “cavalry”, “CAVALRY”, etc.

pub fn use_regex(&self) -> &bool

Whether to interpret the pattern as a regular expression.

When true, the pattern is compiled as a regex. If compilation fails, the search falls back to literal pattern matching.

pub fn sources(&self) -> &Vec<SearchSource>

Which data sources to include in the search.

pub fn search_on(&self) -> &SearchOn

Which file types to search within.

pub fn matches(&self) -> &Matches

Results from the most recent search operation.

pub fn game_key(&self) -> &String

Game key for the files being searched.

Required for decoding certain game-specific file formats during search.

impl GlobalSearch

pub fn pattern_mut(&mut self) -> &mut String

The text pattern or regex to search for.

pub fn replace_text_mut(&mut self) -> &mut String

Text to use for replacements.

This is always a literal string - regex capture groups are not supported in the replacement text.

pub fn case_sensitive_mut(&mut self) -> &mut bool

Whether the search should be case-sensitive.

When false, “Cavalry” will match “cavalry”, “CAVALRY”, etc.

pub fn use_regex_mut(&mut self) -> &mut bool

Whether to interpret the pattern as a regular expression.

When true, the pattern is compiled as a regex. If compilation fails, the search falls back to literal pattern matching.

pub fn sources_mut(&mut self) -> &mut Vec<SearchSource>

Which data sources to include in the search.

pub fn search_on_mut(&mut self) -> &mut SearchOn

Which file types to search within.

pub fn matches_mut(&mut self) -> &mut Matches

Results from the most recent search operation.

pub fn game_key_mut(&mut self) -> &mut String

Game key for the files being searched.

Required for decoding certain game-specific file formats during search.

impl GlobalSearch

pub fn set_pattern(&mut self, val: String) -> &mut Self

The text pattern or regex to search for.

pub fn set_replace_text(&mut self, val: String) -> &mut Self

Text to use for replacements.

This is always a literal string - regex capture groups are not supported in the replacement text.

pub fn set_case_sensitive(&mut self, val: bool) -> &mut Self

Whether the search should be case-sensitive.

When false, “Cavalry” will match “cavalry”, “CAVALRY”, etc.

pub fn set_use_regex(&mut self, val: bool) -> &mut Self

Whether to interpret the pattern as a regular expression.

When true, the pattern is compiled as a regex. If compilation fails, the search falls back to literal pattern matching.

pub fn set_sources(&mut self, val: Vec<SearchSource>) -> &mut Self

Which data sources to include in the search.

pub fn set_search_on(&mut self, val: SearchOn) -> &mut Self

Which file types to search within.

pub fn set_matches(&mut self, val: Matches) -> &mut Self

Results from the most recent search operation.

pub fn set_game_key(&mut self, val: String) -> &mut Self

Game key for the files being searched.

Required for decoding certain game-specific file formats during search.

impl GlobalSearch

pub fn search( &mut self, game_info: &GameInfo, schema: &Schema, packs: &mut BTreeMap<String, Pack>, dependencies: &mut Dependencies, update_paths: &[ContainerPath], )

This function performs a search over the parts of the provided Packs, storing his results.

pub fn clear(&mut self)

This function clears the Global Search result’s data, and reset the UI for it.

pub fn replace_possible(&self, matches: &[MatchHolder]) -> Result<()>

This function checks if it’s possible to replace the provided matches.

pub fn replace( &mut self, game_info: &GameInfo, schema: &Schema, packs: &mut BTreeMap<String, Pack>, dependencies: &mut Dependencies, matches: &[MatchHolder], ) -> Result<Vec<ContainerPath>>

This function performs a replace operation over the provided matches.

NOTE: Schema matches are always ignored.

pub fn replace_all( &mut self, game_info: &GameInfo, schema: &Schema, packs: &mut BTreeMap<String, Pack>, dependencies: &mut Dependencies, ) -> Result<Vec<ContainerPath>>

Trait Implementations

impl Clone for GlobalSearch

fn clone(&self) -> GlobalSearch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalSearch

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

Formats the value using the given formatter.

impl Default for GlobalSearch

fn default() -> GlobalSearch

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GlobalSearch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for GlobalSearch

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

where __S: Serializer,

Serialize this value into the given Serde serializer.