Struct NodeCluster

pub struct NodeCluster {
    controller_id: Endpoint,
    nodes: Box<[Node]>,
}

A globally identified set of nodes that are all located in the same controller.

Sometimes it is more convenient to think about such a group instead of individual GlobalNodes

Fields

controller_id: Endpoint

nodes: Box<[Node]>

Implementations

impl NodeCluster

pub fn new( controller_id: Endpoint, nodes: impl IntoIterator<Item = Node>, ) -> Self

Create a new cluster. This for internal use.

pub fn iter(&self) -> Iter<'_>

Iterate nodes borrowing self

pub fn controller_id(&self) -> Endpoint

Controller that these nodes belong to

pub fn nodes(&self) -> &[Node]

Nodes in this cluster

pub fn try_from_iter(iter: impl IntoIterator<Item = GlobalNode>) -> Option<Self>

Attempt to collect an iterator of nodes into a cluster

Returns None if the iterator was empty or if two nodes did not have identical controller id’s

Trait Implementations

impl Clone for NodeCluster

fn clone(&self) -> NodeCluster

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeCluster

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

Formats the value using the given formatter.

impl Hash for NodeCluster

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterGlobalNodes for &'a NodeCluster

type Iter = Iter<'a>

The iterator returned by Self::iter_nodes

fn iter_nodes(self) -> Self::Iter

iterate over the local nodes

fn controller_id(self) -> Endpoint

The controller id all of these nodes are located in.

fn iter_global_nodes(self) -> GlobalNodeIter<Self>

Iterate all nodes as globally identified one’s.

fn extended(self, other: impl IntoIterGlobalNodes) -> Option<NodeCluster>

A convenience method for gathering multiple node(cluster)s together.

fn to_local_cluster(self) -> NodeCluster

Collect the iterator into a cluster

impl IntoIterator for NodeCluster

type Item = GlobalNode

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.