index

package

v0.0.0-...-3336bd9 Latest Latest Go to latest Published: Mar 2, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Index struct {
	File             *os.File
	Size             uint64
	MemoryMap        gommap.MMap
	UseMemoryMapping bool
}

func NewIndex(optFns ...IndexOptions) (*Index, error)

func (i *Index) Close() error

func (i *Index) Read(in int64) (out uint32, pos uint64, err error)

func (i *Index) Write(off uint32, pos uint64) error

type IndexOptions func(*Options)

Represents a function that applies configuration options to an Options instance

func WithAutoCreate(autoCreate bool) IndexOptions

Option to enable or disable automatic index file creation.

func WithFile(f *os.File) IndexOptions

Set the file to be indexed

func WithFilePath(path string) IndexOptions

Specifies the file path for the store's backing file

func WithMaxIndexBytes(maxIndexBytes uint64) IndexOptions

Sets the maximum number of bytes for the index file itself.

func WithMemoryMapping(use bool) IndexOptions

Enables or disables memory mapping for the index file.

type Options struct {
	File             *os.File
	FilePath         string
	UseMemoryMapping bool
	AutoCreate       bool
	MaxIndexBytes    uint64
}

func DefaultOptions() *Options

Default settings for Index