Struct OffsetAndMetadata 

pub struct OffsetAndMetadata { /* private fields */ }

The Kafka offset commit API allows users to provide additional metadata (in the form of a string) when an offset is committed. This can be useful (for example) to store information about which node made the commit, what time the commit was made, etc.

Implementations

impl OffsetAndMetadata

pub fn new(offset: i64) -> Result<Self, Error>

Construct a new OffsetAndMetadata object for committing through KafkaConsumer. The metadata associated with the commit will be empty.

Arguments

• offset - The offset to be committed

Returns

The new OffsetAndMetadata.

Errors

• Error::is_local_illegal_argument_error if offset is negative.

pub fn with_metadata( offset: i64, metadata: impl Into<String>, ) -> Result<Self, Error>

Construct a new OffsetAndMetadata object for committing through KafkaConsumer.

Arguments

• offset - The offset to be committed
• metadata - Non-null metadata

Returns

The new OffsetAndMetadata.

Errors

• Error::is_local_illegal_argument_error if offset is negative.

pub fn with_leader_epoch_metadata( offset: i64, leader_epoch: Option<i32>, metadata: impl Into<String>, ) -> Result<Self, Error>

Construct a new OffsetAndMetadata object for committing through KafkaConsumer.

Arguments

• offset - The offset to be committed
• leader_epoch - Optional leader epoch of the last consumed record
• metadata - Non-null metadata

Returns

The new OffsetAndMetadata.

Errors

• Error::is_local_illegal_argument_error if offset is negative.

pub fn offset(&self) -> i64

Returns the committed offset.

pub fn metadata(&self) -> &str

Get the metadata of the previously consumed record.

Returns

The metadata or empty string if no metadata

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

Get the leader epoch of the previously consumed record (if one is known). Log truncation is detected if there exists a leader epoch which is larger than this epoch and begins at an offset earlier than the committed offset.

Returns

The leader epoch or empty if not known

Trait Implementations

impl Clone for OffsetAndMetadata

fn clone(&self) -> OffsetAndMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OffsetAndMetadata

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

Formats the value using the given formatter.

impl Display for OffsetAndMetadata

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

Formats the value using the given formatter.

impl Hash for OffsetAndMetadata

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 OffsetAndMetadata

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 OffsetAndMetadata