filekv

package module

v0.0.0-...-d996d46 Latest Latest Go to latest Published: Aug 27, 2023 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Persistent KV storage with atomic CRUD operations.

Basic usage:

This section is empty.

This section is empty.

This section is empty.

type FileKV[K comparable, V any] struct {
	// contains filtered or unexported fields
}

FlieKV Generic KV storage

func New[K comparable, V any](directory string, options ...Option) (*FileKV[K, V], error)

func Recover[K comparable, V any](directory string, hashFunction func(K) []byte) (*FileKV[K, V], error)

func (fileKV *FileKV[K, V]) Create(key K, value V) error

func (fileKV *FileKV[K, V]) Delete(key K) error

func (fileKV *FileKV[K, V]) ForEach(callbackFunc func(K, V))

func (fileKV *FileKV[K, V]) Read(key K) (V, error)

func (fileKV *FileKV[K, V]) Update(key K, updateFunc func(value V) V) error

type Option struct {
	// contains filtered or unexported fields
}

Option FileKV configuration options

func BucketCount(count int) Option

BucketCount create a config option for initial bucket count

func HashFunction[K comparable](hashFunction func(K) []byte) Option

HashFunction create config option for custom hash function

func LoadFactor(loadFactor float64) Option

LoadFactor create config option for load factor