Class SearchIndexer | Quick Search | 1.5.4
docs.unity3d.com
    Show / Hide Table of Contents

    Class SearchIndexer

    Inheritance
    Object
    SearchIndexer
    FileSearchIndexer
    Namespace: Unity.QuickSearch
    Syntax
    public class SearchIndexer

    Constructors

    SearchIndexer(IEnumerable<SearchIndexerRoot>)

    Declaration
    public SearchIndexer(IEnumerable<SearchIndexerRoot> roots)
    Parameters
    Type Name Description
    IEnumerable<SearchIndexerRoot> roots

    SearchIndexer(String)

    Declaration
    public SearchIndexer(string rootPath)
    Parameters
    Type Name Description
    String rootPath

    SearchIndexer(String, String)

    Declaration
    public SearchIndexer(string rootPath, string rootName)
    Parameters
    Type Name Description
    String rootPath
    String rootName

    Properties

    entrySeparators

    Declaration
    public char[] entrySeparators { get; set; }
    Property Value
    Type Description
    Char[]

    enumerateRootEntriesHandler

    Declaration
    public Func<SearchIndexerRoot, IEnumerable<string>> enumerateRootEntriesHandler { get; set; }
    Property Value
    Type Description
    Func<SearchIndexerRoot, IEnumerable<String>>

    getEntryComponentsHandler

    Declaration
    public Func<string, int, IEnumerable<string>> getEntryComponentsHandler { get; set; }
    Property Value
    Type Description
    Func<String, Int32, IEnumerable<String>>

    getIndexFilePathHandler

    Declaration
    public Func<string, string> getIndexFilePathHandler { get; set; }
    Property Value
    Type Description
    Func<String, String>

    getQueryTokensHandler

    Declaration
    public Func<string, string[]> getQueryTokensHandler { get; set; }
    Property Value
    Type Description
    Func<String, String[]>

    maxIndexCharVariation

    Declaration
    public int maxIndexCharVariation { get; set; }
    Property Value
    Type Description
    Int32

    minIndexCharVariation

    Declaration
    public int minIndexCharVariation { get; set; }
    Property Value
    Type Description
    Int32

    roots

    Declaration
    public SearchIndexerRoot[] roots { get; }
    Property Value
    Type Description
    SearchIndexerRoot[]

    skipEntryHandler

    Declaration
    public Func<string, bool> skipEntryHandler { get; set; }
    Property Value
    Type Description
    Func<String, Boolean>

    Methods

    Build()

    Declaration
    public virtual void Build()

    Build(Boolean)

    Declaration
    public void Build(bool useThread)
    Parameters
    Type Name Description
    Boolean useThread

    IsReady()

    Declaration
    public bool IsReady()
    Returns
    Type Description
    Boolean

    Search(String, Int32, Int32)

    Declaration
    public IEnumerable<SearchEntryResult> Search(string query, int maxScore = 2147483647, int patternMatchLimit = 2999)
    Parameters
    Type Name Description
    String query
    Int32 maxScore
    Int32 patternMatchLimit
    Returns
    Type Description
    IEnumerable<SearchEntryResult>

    SearchTerms(String, Int32, Int32)

    Declaration
    public IEnumerable<SearchEntryResult> SearchTerms(string query, int maxScore = 2147483647, int patternMatchLimit = 2999)
    Parameters
    Type Name Description
    String query
    Int32 maxScore
    Int32 patternMatchLimit
    Returns
    Type Description
    IEnumerable<SearchEntryResult>

    UpdateIndexWithNewContent(String[], String[], String[])

    Declaration
    protected void UpdateIndexWithNewContent(string[] updated, string[] removed, string[] moved)
    Parameters
    Type Name Description
    String[] updated
    String[] removed
    String[] moved
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023