Struct TopicDescription 

pub struct TopicDescription { /* private fields */ }

A detailed description of a single topic in the cluster.

Corresponds to org.apache.kafka.clients.admin.TopicDescription.

authorized_operations uses BTreeSet for a deterministic ordering; Java uses an unordered Set<AclOperation>. It is Option because Java’s field is nullable: KafkaAdminClient fills it from AdminUtils.validAclOperations, which returns null when the broker did not report the operations — distinct from a broker reporting an empty set.

Equality mirrors Java’s TopicDescription.equals, which compares name, internal, partitions and authorized_operations but not topic_id — see the manual PartialEq impl below.

Implementations

impl TopicDescription

pub fn new( name: impl Into<String>, internal: bool, partitions: Vec<TopicPartitionInfo>, ) -> Self

Create an instance with name, internal flag and partitions (empty authorized operations, zero topic id).

Mirrors TopicDescription(String, boolean, List<TopicPartitionInfo>), which passes Collections.emptySet() — a reported-but-empty set, i.e. Some(empty) rather than None.

pub fn with_authorized_operations( name: impl Into<String>, internal: bool, partitions: Vec<TopicPartitionInfo>, authorized_operations: Option<BTreeSet<AclOperation>>, ) -> Self

Create an instance with the specified parameters (zero topic id).

• name - the topic name
• internal - whether the topic is internal to Kafka
• partitions - a list of partitions where the index represents the partition id and the element contains leadership and replica information for that partition
• authorized_operations - authorized operations for this topic, or None if this is not known (Java’s nullable Set<AclOperation>)

Mirrors TopicDescription(String, boolean, List<TopicPartitionInfo>, Set<AclOperation>), which passes Uuid.ZERO_UUID.

pub fn with_authorized_operations_topic_id( name: impl Into<String>, internal: bool, partitions: Vec<TopicPartitionInfo>, authorized_operations: Option<BTreeSet<AclOperation>>, topic_id: Uuid, ) -> Self

Create an instance with the specified parameters.

• name - the topic name
• internal - whether the topic is internal to Kafka
• partitions - a list of partitions where the index represents the partition id and the element contains leadership and replica information for that partition
• authorized_operations - authorized operations for this topic, or None if this is not known (Java’s nullable Set<AclOperation>)
• topic_id - the topic id

pub fn name(&self) -> &str

The name of the topic.

pub fn is_internal(&self) -> bool

Whether the topic is internal to Kafka. An example of an internal topic is the offsets and group management topic: __consumer_offsets.

pub fn topic_id(&self) -> Uuid

The topic id.

pub fn partitions(&self) -> &[TopicPartitionInfo]

A list of partitions where the index represents the partition id and the element contains leadership and replica information for that partition.

pub fn authorized_operations(&self) -> Option<&BTreeSet<AclOperation>>

Authorized operations for this topic, or None if the broker did not report them (Java returns null in that case). Some holding an empty set means the broker reported that no operation is authorized.

Trait Implementations

impl Clone for TopicDescription

fn clone(&self) -> TopicDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopicDescription

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

Formats the value using the given formatter.

impl Display for TopicDescription

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

Formats the value using the given formatter.

impl PartialEq for TopicDescription

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 TopicDescription