# Functions
AlwaysEagerDownloadIndexHeader always eagerly download index header.
AlwaysLazyDownloadIndexHeader always lazily download index header.
NewBinaryReader loads or builds new index-header if not present on disk.
NewBinaryReaderMetrics makes new BinaryReaderMetrics.
TODO(bwplotka): Added size to method, upstream this.
NewLazyBinaryReader makes a new LazyBinaryReader.
NewLazyBinaryReaderMetrics makes new LazyBinaryReaderMetrics.
NewReaderPool makes a new ReaderPool.
NewReaderPoolMetrics makes new ReaderPoolMetrics.
WriteBinary build index header from the pieces of index in object storage, and cached in file if necessary.
# Constants
BinaryFormatV1 represents first version of index-header file.
EagerDownloadStrategy always disables lazy downloading index headers.
LazyDownloadStrategy always lazily download index headers.
MagicIndex are 4 bytes at the head of an index-header file.
# Variables
NotFoundRangeErr is an error returned by PostingsOffset when there is no posting for given name and value pairs.
# Structs
LazyBinaryReaderMetrics holds metrics tracked by LazyBinaryReader.
BinaryTOC is a table of content for index-header file.
LazyBinaryReader wraps BinaryReader and loads (mmap) the index-header only upon the first Reader function is called.
LazyBinaryReaderMetrics holds metrics tracked by LazyBinaryReader.
ReaderPool is used to instantiate new index-header readers and keep track of them.
ReaderPoolMetrics holds metrics tracked by ReaderPool.
# Interfaces
Reader is an interface allowing to read essential, minimal number of index fields from the small portion of index file called header.
# Type aliases
IndexHeaderLazyDownloadStrategy specifies how to download index headers lazily.
LazyDownloadIndexHeaderFunc is used to determine whether to download the index header lazily or not by checking its block metadata.