Function New

pkg/consistent/consistent.go:94–125

New initializes and returns a new instance of the Consistent struct. It takes a Config parameter and applies default values for any unset fields.

(config Config)

// New initializes and returns a new instance of the Consistent struct.
// It takes a Config parameter and applies default values for any unset fields.
func New(config Config) *Consistent {
	// Ensure the Hasher is not nil; a nil Hasher would make consistent hashing unusable.
	if config.Hasher == nil {
		panic("Hasher cannot be nil")
	}

	// Set default values for partition count, replication factor, load, and picker width if not provided.
	if config.PartitionCount == 0 {
		config.PartitionCount = DefaultPartitionCount
	}
	if config.ReplicationFactor == 0 {
		config.ReplicationFactor = DefaultReplicationFactor
	}
	if config.Load == 0 {
		config.Load = DefaultLoad
	}
	if config.PickerWidth == 0 {
		config.PickerWidth = DefaultPickerWidth
	}

	// Initialize a new Consistent instance with the provided configuration.
	c := &Consistent{
		config:         config,
		members:        make(map[string]*Member),
		partitionCount: uint64(config.PartitionCount),
		ring:           make(map[uint64]*Member),
	}

	// Assign the provided Hasher implementation to the instance.
	c.hasher = config.Hasher
	return c
}

// Members returns a slice of all the members currently in the consistent hash ring.
// It safely retrieves the members using a read lock to prevent data races while