Enum konsumer_offsets::KonsumerOffsetsData

pub enum KonsumerOffsetsData {
    OffsetCommit(OffsetCommit),
    GroupMetadata(GroupMetadata),
}

Possible types of data stored in __consumer_offsets topic.

This enum is a rust-idiomatic way to handle the fact that the messages read from __consumer_offsets can be of different type. Ideally Kafka could have used 2 different topics, but it doesn’t so… here we are.

Variants

OffsetCommit(OffsetCommit)

Variant that wraps an OffsetCommit struct instance.

GroupMetadata(GroupMetadata)

Variant that wraps a GroupMetadata struct instance.

Implementations

impl KonsumerOffsetsData

pub fn try_from_bytes( key: Option<&[u8]>, payload: Option<&[u8]> ) -> Result<KonsumerOffsetsData, KonsumerOffsetsError>

Parses the content of a messages (a.k.a. records) from the __consumer_offsets.

__consumer_offsets it’s a key internal Kafka topic, used by Kafka Consumers to keep track of the offset consumed so far, and also to coordinate their subscriptions and partition assignments.

This method returns a KonsumerOffsetsData: an enum where each variant represents one of the possible messages that this topic carries. Refer to the documentation of each variant for details.

NOTE: As Kafka messages have key and payload both optional, the signature reflects that. But messages of __consumer_offsets have at least a key set: if absent, the method will return an error.

Arguments

• key - An Option of &[u8]: when set, it means the source Kafka message has a key. If key is None, this function will return an error: it’s likely that the message it’s not actually from the __consumer_offsets topic.
• payload - An Option of &[u8]: when set, it means the source Kafka message has a payload. If payload is None, the source Kafka message is a tombstone.

pub fn try_from_bytes_vec( key: Option<Vec<u8>>, payload: Option<Vec<u8>> ) -> Result<KonsumerOffsetsData, KonsumerOffsetsError>

Same as Self::try_from_bytes, but handling input as Option<Vec<u8>>.

Trait Implementations

impl Clone for KonsumerOffsetsData

fn clone(&self) -> KonsumerOffsetsData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KonsumerOffsetsData

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

Formats the value using the given formatter.

impl PartialEq for KonsumerOffsetsData

fn eq(&self, other: &KonsumerOffsetsData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for KonsumerOffsetsData

impl StructuralPartialEq for KonsumerOffsetsData