Struct ConsistentHashRing 

pub struct ConsistentHashRing { /* private fields */ }

Consistent hash ring with virtual nodes for even load distribution.

Virtual nodes (replicas per real node) help achieve more uniform key distribution even with small cluster sizes.

Example

use oxibonsai_runtime::distributed::ConsistentHashRing;

let mut ring = ConsistentHashRing::new(150);
ring.add_node("node-a");
ring.add_node("node-b");
let target = ring.get_node("my-request-key");
assert!(target.is_some());

Implementations

impl ConsistentHashRing

pub fn new(replicas: usize) -> Self

Create a new empty ring.

replicas controls how many virtual nodes are placed on the ring per real node. Higher values give better distribution at the cost of memory. A value of 100–200 is typical.

pub fn add_node(&mut self, node_id: &str)

Add a node to the ring by inserting replicas virtual nodes.

Virtual node keys are "<node_id>#<i>" for i in 0..replicas. After insertion the internal slice is re-sorted.

pub fn remove_node(&mut self, node_id: &str)

Remove all virtual nodes belonging to node_id from the ring.

pub fn get_node(&self, key: &str) -> Option<&str>

Route a key to the first virtual node at or after its hash position.

Returns None if the ring is empty.

pub fn get_nodes(&self, key: &str, count: usize) -> Vec<&str>

Route a key and return up to count distinct real nodes in ring order.

Useful for replication — returns the first count unique node IDs encountered walking clockwise from the key’s position.

pub fn node_count(&self) -> usize

Number of distinct real nodes currently on the ring.

pub fn vnode_count(&self) -> usize

Total number of virtual nodes on the ring (replicas × node_count).