consistenthash

package

v0.10.0 Latest Latest Go to latest Published: Aug 10, 2025 License: BSD-3-Clause Imports: 3 Imported by: 0

Details

Package consistenthash provides an implementation of consistent hashing.

This section is empty.

This section is empty.

This section is empty.

type HashFunc func(b []byte) uint32

HashFunc is a function type that implements the Hasher interface.

func (hf HashFunc) Hash(b []byte) uint32

Hash implements the Hasher interface for HashFunc.

type Hasher interface {
	Hash(b []byte) uint32
}

Hasher defines an interface for hash functions that produce uint32 values.

type Map struct {
	Hasher Hasher
	// contains filtered or unexported fields
}

Map implements consistent hashing ring.

func New(k int, h Hasher) *Map

New creates a new Map.

func (m *Map) Add(keys ...string)

Add adds some keys to the hash.

func (m *Map) Get(key string) string

Get gets the closest item in the hash to the provided key.

func (m *Map) IsEmpty() bool

Returns true if there are no items available.

func (m *Map) ReadFrom(r io.Reader) (n int64, err error)

ReadFrom implements io.ReaderFrom.

func (m Map) WriteTo(w io.Writer) (n int64, err error)

WriteTo implements io.WriterTo.