sharder

Documentation

Index

• type Hasher
• type Opt
  • func WithHasher(f Hasher) Opt
  • func WithLockFreeHasher() Opt
  • func WithLockingHasher() Opt
• type Sharder
  • func New(total int, opts ...Opt) *Sharder
  • func (s *Sharder) Index(key string) int

Types

type Hasher

type Hasher interface {
	Hash(key string) uint32
}

Hasher is the common interface to hash a given key.

type Opt

type Opt func(*Sharder)

Opt is used to customer the Sharder's Hasher.

func WithHasher

func WithHasher(f Hasher) Opt

WithHasher allows for custom Hasher implementations.

func WithLockFreeHasher

func WithLockFreeHasher() Opt

WithLockFreeHasher implements the Hasher interface using lock-free fnv32.

func WithLockingHasher

func WithLockingHasher() Opt

WithLockingHasher is the default Hasher, implemented using a locking fnv32 algorithm.

type Sharder

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

Sharder determines the shard number for a key.

func New

func New(total int, opts ...Opt) *Sharder

New returns a new Sharder with the specified number of shards.

func (*Sharder) Index

func (s *Sharder) Index(key string) int

Index returns a shard index for the given key. The index is in the range 0..total exclusive.