Struct rendezvous_hash::RendezvousNodes

pub struct RendezvousNodes<N: Node, H> { /* fields omitted */ }

A candidate node set of a rendezvous for clients that are requiring the same item.

Methods

impl<N, H> RendezvousNodes<N, H> where
    N: Node,
    H: NodeHasher<N::NodeId>, 

pub fn new(hasher: H) -> Self

Makes a new RendezvousNodes instance.

Important traits for Candidates<'a, N>

impl<'a, N: 'a + Node> Iterator for Candidates<'a, N> type Item = &'a N;

pub fn calc_candidates<T: Hash>(&mut self, item: &T) -> Candidates<N>

Returns the candidate nodes for item.

The higher priority node is located in front of the returned candidate sequence.

Note that this method takes O(n log n) steps (where n is the return value of self.len()).

pub fn calc_candidates_immut<T: Hash>(
    &self,
    item: &T
) -> impl Iterator<Item = &N>

Returns the candidate nodes for item.

The higher priority node is located in front of the returned candidate sequence.

Note that this method takes O(n log n) steps (where n is the return value of self.len()).

This is equivalent to calc_candidates method except this allocates n * (size_of<usize>() + size_of<N::HashCode>()) memory internally.

impl<N: Node, H> RendezvousNodes<N, H>

pub fn insert(&mut self, node: N) -> Option<N>

Inserts a new candidate node.

If a node which has an identifier equal to node exists, it will be removed and returned as Some(N).

pub fn remove<M>(&mut self, node_id: &M) -> Option<N> where
    N::NodeId: Borrow<M>,
    M: PartialEq, 

Removes the specified node from the candidates.

If the node does not exist, this method will return None.

pub fn contains<M>(&self, node_id: &M) -> bool where
    N::NodeId: Borrow<M>,
    M: PartialEq, 

Returns true if the specified node exists in this candidate set, otherwise false.

pub fn is_empty(&self) -> bool

Returns true if there are no candidate nodes.

pub fn len(&self) -> usize

Returns the count of the candidate nodes.

Important traits for Iter<'a, T>

impl<'a, T: 'a + Node> Iterator for Iter<'a, T> type Item = &'a T;

pub fn iter(&self) -> Iter<N>

Returns an iterator over the nodes of this candidate set.

Trait Implementations

impl<N: Node, H> Extend<N> for RendezvousNodes<N, H>

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = N>, 

Extends a collection with the contents of an iterator.

impl<N: Node> Default for RendezvousNodes<N, DefaultNodeHasher>

fn default() -> Self

Returns the "default value" for a type.

impl<N: Node, H> IntoIterator for RendezvousNodes<N, H>

type Item = N

The type of the elements being iterated over.

type IntoIter = IntoIter<N>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.