Skip to main content

ConsumerGroup

Struct ConsumerGroup 

Source
pub struct ConsumerGroup {
    pub group_id: String,
    pub members: HashMap<SubscriberId, HashSet<String>>,
    pub committed_offsets: HashMap<String, u64>,
    pub created_at: u64,
}
Expand description

A consumer group that coordinates message consumption across multiple subscribers.

Each member is assigned a set of channels, and the group tracks committed offsets per channel so that consumers can resume from where they left off.

Fields§

§group_id: String

Unique identifier for this consumer group.

§members: HashMap<SubscriberId, HashSet<String>>

Map of subscriber_id -> set of assigned channel names.

§committed_offsets: HashMap<String, u64>

Map of channel_name -> committed offset.

§created_at: u64

Timestamp when the group was created.

Implementations§

Source§

impl ConsumerGroup

Source

pub fn new(group_id: impl Into<String>) -> Self

Create a new consumer group with the given ID.

Source

pub fn add_member( &mut self, subscriber_id: SubscriberId, channels: HashSet<String>, )

Add a member to the consumer group with an initial set of assigned channels.

Source

pub fn remove_member( &mut self, subscriber_id: &SubscriberId, ) -> Option<HashSet<String>>

Remove a member from the consumer group. Returns the channels that were assigned to the removed member, or None if the member was not found.

Source

pub fn commit_offset(&mut self, channel_name: impl Into<String>, offset: u64)

Commit an offset for a channel. This records the position up to which messages have been successfully processed.

Source

pub fn get_offset(&self, channel_name: &str) -> Option<u64>

Get the committed offset for a channel. Returns None if no offset has been committed for that channel.

Source

pub fn member_count(&self) -> usize

Get the number of members in the group.

Source

pub fn is_member(&self, subscriber_id: &SubscriberId) -> bool

Check if a subscriber is a member of this group.

Source

pub fn get_member_channels( &self, subscriber_id: &SubscriberId, ) -> Option<&HashSet<String>>

Get the channels assigned to a specific member.

Trait Implementations§

Source§

impl Clone for ConsumerGroup

Source§

fn clone(&self) -> ConsumerGroup

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConsumerGroup

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.