Record
public record SearchIndex : System.IEquatable<Moka.Docs.Core.Search.SearchIndex>

Namespace: Moka.Docs.Core.Search

A pre-built search index for client-side search functionality.

Inheritance

Implements: System.IEquatable<Moka.Docs.Core.Search.SearchIndex>

Properties

NameDescription
Count Total number of entries.
Empty static Empty search index.
Entries All searchable entries.

Count

int SearchIndex.Count { get; }

Total number of entries.

Empty

SearchIndex SearchIndex.Empty { get; }

Empty search index.

Entries

List<SearchEntry> SearchIndex.Entries { get; init; }

All searchable entries.

Type Relationships
classDiagram
                    style SearchIndex fill:#f9f,stroke:#333,stroke-width:2px
                    SearchIndex ..|> SearchIndex~ : implements
                
View Source
/// <summary>
///     A pre-built search index for client-side search functionality.
/// </summary>
public sealed record SearchIndex
{
    /// <summary>All searchable entries.</summary>
    public List<SearchEntry> Entries { get; init; } = [];
    /// <summary>Total number of entries.</summary>
    public int Count => Entries.Count;
    /// <summary>Empty search index.</summary>
    public static SearchIndex Empty => new();
}
Was this page helpful?