Struct Subscription 

pub struct Subscription { /* private fields */ }

Represents a consumer’s subscription information including topics, user data, and owned partitions.

Implementations

impl Subscription

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

Constructs a basic subscription with only topics.

Arguments

• topics - The list of topics to subscribe to

Returns

The new Subscription.

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

Constructs a subscription without owned partitions.

Arguments

• topics - The list of topics to subscribe to
• user_data - Nullable user data to include in the subscription

Returns

The new Subscription.

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

Constructs a subscription without generation ID and rack ID.

Arguments

• topics - The list of topics to subscribe to
• user_data - Nullable user data to include in the subscription
• owned_partitions - The partitions currently owned by this consumer

Returns

The new Subscription.

pub fn with_options(options: SubscriptionOptions) -> Self

Constructs a subscription with full details.

Arguments

• options - The topics, user data, owned partitions, generation ID and rack ID

Returns

The new Subscription.

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

The subscribed topics.

Returns

The list of topics

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

The opaque user data attached to the subscription.

Returns

The user data, or None if none was provided

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

The partitions currently owned by the member.

Returns

The list of owned partitions

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

The rack id of the member, if any.

Returns

The rack ID, or empty if not provided

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

Sets the group instance id.

Arguments

• group_instance_id - The group instance ID

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

The group instance id of the member, if any.

Returns

The group instance ID, or empty if this is a dynamic member

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

The generation id of the subscription, if any.

Returns

The generation ID, or empty if not provided

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 Display for Subscription

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

Formats the value using the given formatter.