consistenthash

Documentation

Overview

Package consistenthash provides an implementation of a ring hash.

Index

• type Hash
• type Map
  • func New[T any](replicas int, fn Hash) *Map[T]
  • func (m *Map[T]) Add(key string, v T)
  • func (m *Map[T]) Get(key string) T
  • func (m *Map[T]) IsEmpty() bool

Types

type Hash

type Hash func(data []byte) uint32

type Map

type Map[T any] struct {
	// contains filtered or unexported fields
}

func New

func New[T any](replicas int, fn Hash) *Map[T]

func (*Map[T]) Add

func (m *Map[T]) Add(key string, v T)

Add adds some keys to the hash.

func (*Map[T]) Get

func (m *Map[T]) Get(key string) T

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

func (*Map[T]) IsEmpty

func (m *Map[T]) IsEmpty() bool

IsEmpty returns true if there are no items available.