Struct Cluster 

pub struct Cluster { /* private fields */ }

An immutable representation of a subset of the nodes, topics, and partitions in the Kafka cluster.

Implementations

impl Cluster

pub fn new( cluster_id: Option<String>, nodes: Vec<Node>, partitions: Vec<PartitionInfo>, unauthorized_topics: HashSet<String>, internal_topics: HashSet<String>, ) -> Self

Create a new cluster with the given id, nodes and partitions.

Arguments

• cluster_id - the cluster id, or None if unknown
• nodes - The nodes in the cluster
• partitions - Information about a subset of the topic-partitions this cluster hosts
• unauthorized_topics - the topics the client is not authorized to access
• internal_topics - the internal topics

pub fn with_controller( cluster_id: Option<String>, nodes: Vec<Node>, partitions: Vec<PartitionInfo>, unauthorized_topics: HashSet<String>, internal_topics: HashSet<String>, controller: Option<Node>, ) -> Self

Create a new cluster with the given id, nodes, partitions and controller.

Arguments

• cluster_id - the cluster id, or None if unknown
• nodes - The nodes in the cluster
• partitions - Information about a subset of the topic-partitions this cluster hosts
• unauthorized_topics - the topics the client is not authorized to access
• internal_topics - the internal topics
• controller - the controller node, or None if unknown

pub fn with_invalid_topics_controller( cluster_id: Option<String>, nodes: Vec<Node>, partitions: Vec<PartitionInfo>, unauthorized_topics: HashSet<String>, invalid_topics: HashSet<String>, internal_topics: HashSet<String>, controller: Option<Node>, ) -> Self

Create a new cluster with the given id, nodes, partitions, invalid topics and controller.

Arguments

• cluster_id - the cluster id, or None if unknown
• nodes - The nodes in the cluster
• partitions - Information about a subset of the topic-partitions this cluster hosts
• unauthorized_topics - the topics the client is not authorized to access
• invalid_topics - the topics whose names are invalid
• internal_topics - the internal topics
• controller - the controller node, or None if unknown

pub fn with_invalid_topics_controller_topic_ids( cluster_id: Option<String>, nodes: Vec<Node>, partitions: Vec<PartitionInfo>, unauthorized_topics: HashSet<String>, invalid_topics: HashSet<String>, internal_topics: HashSet<String>, controller: Option<Node>, topic_ids: HashMap<String, Uuid>, ) -> Self

Create a new cluster with the given id, nodes, partitions and topic ids.

Arguments

• cluster_id - the cluster id, or None if unknown
• nodes - The nodes in the cluster
• partitions - Information about a subset of the topic-partitions this cluster hosts
• unauthorized_topics - the topics the client is not authorized to access
• invalid_topics - the topics whose names are invalid
• internal_topics - the internal topics
• controller - the controller node, or None if unknown
• topic_ids - the topic ids, keyed by topic name

pub fn empty() -> Self

Create an empty cluster instance with no nodes and no topic-partitions.

pub fn bootstrap(addresses: &[(String, SocketAddr)]) -> Self

Create a “bootstrap” cluster using the given list of host/ports.

Arguments

• addresses - The addresses

Returns

A cluster for these hosts/ports

pub fn with_partitions( &self, partitions: HashMap<TopicPartition, PartitionInfo>, ) -> Self

Returns a copy of this cluster combined with partitions.

Arguments

• partitions - the partitions to add, keyed by topic-partition

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

Returns the known set of nodes.

pub fn node_by_id(&self, id: i32) -> Option<&Node>

Get the node by the node id (or None if the node is not online or does not exist).

Arguments

• id - The id of the node

Returns

The node, or None if the node is not online or does not exist

pub fn node_if_online( &self, partition: &TopicPartition, id: i32, ) -> Option<&Node>

Get the node by node id if the replica for the given partition is online.

Arguments

• partition - The TopicPartition
• id - The node id

Returns

the node

pub fn leader_for(&self, topic_partition: &TopicPartition) -> Option<&Node>

Get the current leader for the given topic-partition.

Arguments

• topic_partition - The topic and partition we want to know the leader for

Returns

The node that is the leader for this topic-partition, or None if there is currently no leader

pub fn partition( &self, topic_partition: &TopicPartition, ) -> Option<&PartitionInfo>

Get the metadata for the specified partition.

Arguments

• topic_partition - The topic and partition to fetch info for

Returns

The metadata about the given topic and partition, or None if none is found

pub fn partitions_for_topic(&self, topic: &str) -> &[PartitionInfo]

Get the list of partitions for this topic.

Arguments

• topic - The topic name

Returns

A list of partitions

pub fn partition_count_for_topic(&self, topic: &str) -> Option<usize>

Get the number of partitions for the given topic.

Arguments

• topic - The topic to get the number of partitions for

Returns

The number of partitions or None if there is no corresponding metadata

pub fn available_partitions_for_topic(&self, topic: &str) -> &[PartitionInfo]

Get the list of available partitions for this topic.

Arguments

• topic - The topic name

Returns

A list of partitions

pub fn partitions_for_node(&self, node_id: i32) -> &[PartitionInfo]

Get the list of partitions whose leader is this node.

Arguments

• node_id - The node id

Returns

A list of partitions

pub fn topics(&self) -> impl Iterator<Item = &str>

Get all topics.

Returns

a set of all topics

pub fn unauthorized_topics(&self) -> &HashSet<String>

Returns the topics the client is not authorized to access.

pub fn invalid_topics(&self) -> &HashSet<String>

Returns the topics whose names are invalid.

pub fn internal_topics(&self) -> &HashSet<String>

Returns the internal topics.

pub fn is_bootstrap_configured(&self) -> bool

Returns whether this is a bootstrap cluster.

pub fn cluster_resource(&self) -> &ClusterResource

Returns the cluster resource metadata.

pub fn controller(&self) -> Option<&Node>

Returns the controller node, or None if unknown.

pub fn topic_ids(&self) -> impl Iterator<Item = &Uuid>

Returns the ids of all topics.

pub fn topic_id(&self, topic: &str) -> Uuid

Returns the topic id for the given topic name, Uuid::ZERO_UUID if unknown.

Arguments

• topic - the topic name

pub fn topic_name(&self, topic_id: &Uuid) -> Option<&str>

Returns the topic name for the given topic id, or None if unknown.

Arguments

• topic_id - the topic id

Trait Implementations

impl Clone for Cluster

fn clone(&self) -> Cluster

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cluster

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

Formats the value using the given formatter.

impl Display for Cluster

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

Formats the value using the given formatter.

impl Hash for Cluster

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 PartialEq for Cluster

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Cluster