Skip to main content

ConsistentHash

Struct ConsistentHash 

Source
pub struct ConsistentHash { /* private fields */ }
Expand description

Consistent hashing with virtual nodes.

Routes requests with the same hash_key to the same node, and minimizes remapping when nodes are added or removed.

The hash ring is cached and only rebuilt when the candidate set changes.

Requires SelectionContext::hash_key to be set for meaningful routing. When hash_key is None, defaults to 0 — all unkeyed requests route to the same node.

§Examples

use loadwise::{Node, Strategy, SelectionContext};
use loadwise::strategy::ConsistentHash;

struct Backend(String);
impl Node for Backend {
    type Id = String;
    fn id(&self) -> &String { &self.0 }
}

let ch = ConsistentHash::default(); // 150 virtual nodes per real node
let nodes = [Backend("a".into()), Backend("b".into()), Backend("c".into())];

// Same hash_key always maps to the same node.
let ctx = SelectionContext::builder().hash_key(42).build();
let first  = ch.select(&nodes, &ctx);
let second = ch.select(&nodes, &ctx);
assert_eq!(first, second);

Implementations§

Source§

impl ConsistentHash

Source

pub fn builder() -> ConsistentHashBuilder

Create an instance of ConsistentHash using the builder syntax

Trait Implementations§

Source§

impl Debug for ConsistentHash

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ConsistentHash

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<N: Node> Strategy<N> for ConsistentHash

Source§

fn select(&self, candidates: &[N], ctx: &SelectionContext) -> Option<usize>

Pick the next node. Returns None when candidates is empty or all candidates are excluded via SelectionContext::exclude.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V