pub struct ConsistentHashRing { /* private fields */ }Expand description
A consistent-hash ring mapping arbitrary byte keys to ShardIds.
Each shard occupies virtual_nodes (default 150) positions on the ring,
providing excellent key distribution even with a small number of shards.
§Lookup algorithm
- Hash the key with FNV-1a.
- Find the first ring position ≥ the hash (wrap-around to the minimum position if none exists — standard consistent-hashing).
- Return the
ShardIdat that ring position.
Implementations§
Source§impl ConsistentHashRing
impl ConsistentHashRing
Sourcepub fn new(virtual_nodes: usize) -> Self
pub fn new(virtual_nodes: usize) -> Self
Create a new ring with the given number of virtual nodes per shard.
Sourcepub fn add_shard(&mut self, shard_id: ShardId, _peer_id: &str)
pub fn add_shard(&mut self, shard_id: ShardId, _peer_id: &str)
Add shard_id to the ring, placing virtual_nodes replicas.
peer_id is accepted for future extensibility (e.g., zone-aware
placement) but is not stored inside the ring itself — it lives in
VectorShard.
Sourcepub fn remove_shard(&mut self, shard_id: ShardId)
pub fn remove_shard(&mut self, shard_id: ShardId)
Remove shard_id from the ring, deleting all its virtual nodes.
Sourcepub fn get_shard(&self, key: &[u8]) -> Option<ShardId>
pub fn get_shard(&self, key: &[u8]) -> Option<ShardId>
Find the shard responsible for key.
Returns None only when the ring is empty.
Sourcepub fn shard_count(&self) -> usize
pub fn shard_count(&self) -> usize
Number of distinct shards currently on the ring.
Trait Implementations§
Source§impl Clone for ConsistentHashRing
impl Clone for ConsistentHashRing
Source§fn clone(&self) -> ConsistentHashRing
fn clone(&self) -> ConsistentHashRing
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for ConsistentHashRing
impl Debug for ConsistentHashRing
Auto Trait Implementations§
impl Freeze for ConsistentHashRing
impl RefUnwindSafe for ConsistentHashRing
impl Send for ConsistentHashRing
impl Sync for ConsistentHashRing
impl Unpin for ConsistentHashRing
impl UnsafeUnpin for ConsistentHashRing
impl UnwindSafe for ConsistentHashRing
Blanket Implementations§
impl<T> Allocation for T
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.