Struct consistent_hash_ring::RingBuilder

pub struct RingBuilder<T, S = FnvBuildHasher> where
    T: Hash + Eq + Clone,
    S: BuildHasher,  { /* fields omitted */ }

A builder for Ring.

Methods

impl<T: Hash + Eq + Clone, S: BuildHasher> RingBuilder<T, S>

pub fn new(hasher: S) -> Self

Returns a new RingBuilder with the specified BuildHasher.

pub fn vnodes(self, vnodes: usize) -> Self

Specifies the number of vnodes for each node.

The default is 10.

pub fn replicas(self, replicas: usize) -> Self

Specifies the number of replicas for each key.

The default is 1.

pub fn weighted_node(self, node: T, vnodes: usize) -> Self

Ensure that the built Ring contains node with the specified number of vnodes (regardless of the default vnode count).

pub fn weighted_nodes(self, weighted_nodes: &[(T, usize)]) -> Self

Ensure that the built Ring contains all nodes in the provided slice with the associated number of vnodes (regardless of the default vnode count).

pub fn weighted_nodes_iter<I>(self, weighted_nodes: I) -> Self where
    I: Iterator<Item = (T, usize)>, 

Ensure that the built Ring contains all nodes in the provided iterator with the associated number of vnodes (regardless of the default vnode count).

pub fn node(self, node: T) -> Self

Ensure that the built Ring contains the provided node.

pub fn nodes(self, nodes: &[T]) -> Self

Ensure that the built Ring contains all nodes in the provided slice.

pub fn nodes_iter<I>(self, nodes: I) -> Self where
    I: Iterator<Item = T>, 

Ensure that the built Ring contains all nodes in the provided iterator.

pub fn build(self) -> Ring<T, S>

Build the Ring.

Trait Implementations

impl<T: Hash + Eq + Clone> Default for RingBuilder<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Clone, S: Clone> Clone for RingBuilder<T, S> where
    T: Hash + Eq + Clone,
    S: BuildHasher, 

fn clone(&self) -> RingBuilder<T, S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.