Struct TopicDescription 

pub struct TopicDescription { /* private fields */ }

A detailed description of a single topic in the cluster.

Implementations

impl TopicDescription

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

Create an instance with the specified parameters.

Arguments

• 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.

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.

Arguments

• 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.

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.

Arguments

• 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.
• topic_id - the topic id

pub fn name(&self) -> &str

Returns the name of the topic.

pub fn is_internal(&self) -> bool

Returns 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

Returns the topic id.

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

Returns 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>>

Returns the authorized operations for this topic, or None if this is not known.

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 Hash for TopicDescription

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 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