FindMyFiles
FindMyFiles.Engine
SearchOptions Class
The knobs that shape a search, passed to
SearchAsync(string, SearchOptions, CancellationToken) (the C# face of fmf-core's
FmfQueryOptions).
public sealed record SearchOptions : System.IEquatable<FindMyFiles.Engine.SearchOptions>
Inheritance System.Object → SearchOptions
Implements System.IEquatable<SearchOptions>
Constructors
SearchOptions(FmfSort, bool, FmfCase, bool, bool, RegexScope) Constructor
The knobs that shape a search, passed to
SearchAsync(string, SearchOptions, CancellationToken) (the C# face of fmf-core's
FmfQueryOptions).
public SearchOptions(FindMyFiles.Engine.FmfSort Sort, bool Descending, FindMyFiles.Engine.FmfCase Case, bool IncludeHiddenSystem=false, bool RegexMode=false, FindMyFiles.Engine.RegexScope Scope=FindMyFiles.Engine.RegexScope.Name);
Parameters
Sort FmfSort
Which key to order results by.
Descending System.Boolean
True for descending order; false for ascending.
Case FmfCase
How query case is matched against names.
IncludeHiddenSystem System.Boolean
When true, hidden/system entries are included; they are excluded by default.
RegexMode System.Boolean
When true, the whole query text is one regular
expression (the regex: per-term syntax still works regardless).
Scope RegexScope
Which haystack the whole-query regex matches against (ignored unless RegexMode).
Fields
SearchOptions.Default Field
The app's default search: by Name, ascending, Smart case, hidden/system excluded, regex mode off.
public static readonly SearchOptions Default;
Field Value
Properties
SearchOptions.Case Property
How query case is matched against names.
public FindMyFiles.Engine.FmfCase Case { get; init; }
Property Value
SearchOptions.Descending Property
True for descending order; false for ascending.
public bool Descending { get; init; }
Property Value
SearchOptions.IncludeHiddenSystem Property
When true, hidden/system entries are included; they are excluded by default.
public bool IncludeHiddenSystem { get; init; }
Property Value
SearchOptions.RegexMode Property
When true, the whole query text is one regular
expression (the regex: per-term syntax still works regardless).
public bool RegexMode { get; init; }
Property Value
SearchOptions.RegexModeBits Property
The packed FmfQueryOptions.regex_mode wire value:
bit0 = whole-query regex on, bit1 = scope (0 name / 1 path).
public uint RegexModeBits { get; }
Property Value
SearchOptions.Scope Property
Which haystack the whole-query regex matches against (ignored unless RegexMode).
public FindMyFiles.Engine.RegexScope Scope { get; init; }
Property Value
SearchOptions.Sort Property
Which key to order results by.
public FindMyFiles.Engine.FmfSort Sort { get; init; }