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.

Corresponds to Java’s org.apache.kafka.clients.consumer.OffsetAndMetadata.

Implementations

impl OffsetAndMetadata

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

Construct a new OffsetAndMetadata with the given offset. The metadata is set to the empty string and no leader epoch is set.

Corresponds to Java’s new OffsetAndMetadata(long offset).

Errors

Returns Error::LocalIllegalArgument if offset is negative (matching Java’s IllegalArgumentException).

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

Construct a new OffsetAndMetadata with the given offset and metadata.

Corresponds to Java’s new OffsetAndMetadata(long offset, String metadata).

Errors

Returns Error::LocalIllegalArgument 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 with offset, optional leader epoch, and metadata.

Corresponds to Java’s new OffsetAndMetadata(long, Optional<Integer>, String).

Errors

Returns Error::LocalIllegalArgument if offset is negative.

pub fn offset(&self) -> i64

The committed offset.

pub fn metadata(&self) -> &str

Returns the metadata associated with the commit, or an empty string if no metadata was provided.

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

Get the leader epoch of the previously consumed record (if one is known). Negative epochs are filtered to None to match Java’s leaderEpoch().

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

Matches Java’s toString(): OffsetAndMetadata{offset=N, leaderEpoch=X, metadata='Y'} where X is null if no leader epoch is present.

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