Skip to main content

ClusterState

Struct ClusterState 

Source
#[non_exhaustive]
pub struct ClusterState { pub local_node: NodeId, pub nodes: Vec<NodeId>, pub is_leader: bool, pub wire_version: WireVersion, pub app_version: Option<String>, pub peer_versions: HashMap<NodeId, PeerVersionInfo>, }
Expand description

Snapshot of the cluster state at a point in time.

Includes topology (which nodes are known), version information for each peer, and the local node’s own version metadata. This is the primary type for operational visibility during rolling upgrades.

§Invariants

  • nodes includes the local node.
  • peer_versions excludes the local node (local version info is in wire_version and app_version).
  • Every connected remote node in nodes should have a corresponding entry in peer_versions.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§local_node: NodeId

The local node’s identity.

§nodes: Vec<NodeId>

All known nodes in the cluster (including local).

§is_leader: bool

Whether this node considers itself the leader (if applicable).

§wire_version: WireVersion

This node’s wire protocol version.

§app_version: Option<String>

This node’s application version, if configured. Purely informational — does not affect compatibility.

§peer_versions: HashMap<NodeId, PeerVersionInfo>

Version metadata for each connected remote peer. Populated from successful handshake responses. Keyed by NodeId; does not include the local node.

Implementations§

Source§

impl ClusterState

Source

pub fn new(local_node: NodeId, nodes: Vec<NodeId>) -> Self

Create a new ClusterState with the given local node and defaults.

Sets wire_version to DACTOR_WIRE_VERSION, app_version to None, is_leader to false, and empty peer_versions.

Source

pub fn node_count(&self) -> usize

Number of nodes in the cluster.

Source

pub fn contains(&self, node_id: &NodeId) -> bool

Check if a specific node is in the cluster.

Source

pub fn peer_version(&self, node_id: &NodeId) -> Option<&PeerVersionInfo>

Look up version information for a remote peer.

Trait Implementations§

Source§

impl Clone for ClusterState

Source§

fn clone(&self) -> ClusterState

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClusterState

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more