Struct Subscription 

pub struct Subscription { /* private fields */ }

A consumer member’s subscription.

Corresponds to ConsumerPartitionAssignor.Subscription.

Implementations

impl Subscription

pub fn new(topics: Vec<String>) -> Self

Creates a subscription from topics only.

Mirrors Subscription(List) (:130).

pub fn with_user_data(topics: Vec<String>, user_data: Option<Vec<u8>>) -> Self

Creates a subscription from topics and optional user data.

Mirrors Subscription(List, ByteBuffer) (:126).

pub fn with_user_data_owned_partitions( topics: Vec<String>, user_data: Option<Vec<u8>>, owned_partitions: Vec<TopicPartition>, ) -> Self

Creates a subscription from topics, optional user data and owned partitions (default generation, no rack).

Mirrors Subscription(List, ByteBuffer, List) (:122).

pub fn with_options(options: SubscriptionOptions) -> Self

Creates a subscription with all fields.

Mirrors Subscription(List, ByteBuffer, List, int, Optional<String>) (:113); all five of its parameters are carried by SubscriptionOptions — see the note above this overload group.

A generation_id less than zero is mapped to None, matching Java’s generationId < 0 ? Optional.empty() : Optional.of(generationId).

pub fn topics(&self) -> &[String]

The subscribed topics.

pub fn user_data(&self) -> Option<&[u8]>

The opaque user data attached to the subscription.

pub fn owned_partitions(&self) -> &[TopicPartition]

The partitions currently owned by the member.

pub fn rack_id(&self) -> Option<&str>

The rack id of the member, if any.

pub fn set_group_instance_id(&mut self, group_instance_id: Option<String>)

Sets the group instance id.

pub fn group_instance_id(&self) -> Option<&str>

The group instance id of the member, if any.

pub fn generation_id(&self) -> Option<i32>

The generation id of the subscription, if any.

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.

impl PartialEq for Subscription

fn eq(&self, other: &Subscription) -> 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 Subscription

impl StructuralPartialEq for Subscription