Trait Searchable 

pub trait Searchable {
    type SearchMatches;

    // Required method
    fn search(
        &self,
        file_path: &str,
        pattern_to_search: &str,
        case_sensitive: bool,
        matching_mode: &MatchingMode,
    ) -> Self::SearchMatches;
}

Trait for file types that support text searching.

Implementors of this trait can be scanned for text matches using various matching modes (pattern, regex, case-sensitive, etc.).

Associated Types

• SearchMatches: The type returned containing match results, specific to each file type (e.g., TableMatches for DB/Loc files).

Required Associated Types

type SearchMatches

The type containing search results for this searchable type.

Required Methods

fn search( &self, file_path: &str, pattern_to_search: &str, case_sensitive: bool, matching_mode: &MatchingMode, ) -> Self::SearchMatches

Performs a search and returns all matches.

Arguments

• file_path - Path of the file being searched (for result reporting)
• pattern_to_search - The search pattern or regex
• case_sensitive - Whether matching should be case-sensitive
• matching_mode - How to interpret the pattern (literal vs regex)

Returns

A match result struct containing all found matches with their locations.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Searchable for AnimFragmentBattle

type SearchMatches = AnimFragmentBattleMatches

fn search( &self, file_path: &str, pattern: &str, case_sensitive: bool, matching_mode: &MatchingMode, ) -> AnimFragmentBattleMatches

impl Searchable for Atlas

type SearchMatches = AtlasMatches

fn search( &self, file_path: &str, pattern: &str, case_sensitive: bool, matching_mode: &MatchingMode, ) -> AtlasMatches

impl Searchable for DB

type SearchMatches = TableMatches

fn search( &self, file_path: &str, pattern_to_search: &str, case_sensitive: bool, matching_mode: &MatchingMode, ) -> TableMatches

impl Searchable for Loc

type SearchMatches = TableMatches

fn search( &self, file_path: &str, pattern_to_search: &str, case_sensitive: bool, matching_mode: &MatchingMode, ) -> TableMatches

impl Searchable for PortraitSettings

type SearchMatches = PortraitSettingsMatches

fn search( &self, file_path: &str, pattern: &str, case_sensitive: bool, matching_mode: &MatchingMode, ) -> PortraitSettingsMatches

impl Searchable for RigidModel

type SearchMatches = RigidModelMatches

fn search( &self, file_path: &str, pattern: &str, case_sensitive: bool, matching_mode: &MatchingMode, ) -> RigidModelMatches

impl Searchable for Schema

fn search( &self, _file_path: &str, pattern_to_search: &str, case_sensitive: bool, matching_mode: &MatchingMode, ) -> SchemaMatches

This function performs a search over the provided Text PackedFile.

type SearchMatches = SchemaMatches

impl Searchable for Text

type SearchMatches = TextMatches

fn search( &self, file_path: &str, pattern: &str, case_sensitive: bool, matching_mode: &MatchingMode, ) -> TextMatches

impl Searchable for UnitVariant

type SearchMatches = UnitVariantMatches

fn search( &self, file_path: &str, pattern: &str, case_sensitive: bool, matching_mode: &MatchingMode, ) -> UnitVariantMatches

impl Searchable for Unknown

type SearchMatches = UnknownMatches

fn search( &self, file_path: &str, pattern: &str, case_sensitive: bool, matching_mode: &MatchingMode, ) -> UnknownMatches

Implementors