Struct ConsumerLogTruncationError 

pub struct ConsumerLogTruncationError { /* private fields */ }

In the event of an unclean leader election, the log will be truncated, previously committed data will be lost, and new data will be written over these offsets. When this happens, the consumer will detect the truncation and return this error (if no automatic reset policy has been defined) with the first offset known to diverge from what the consumer previously read.

Implementations

impl ConsumerLogTruncationError

pub fn new( offset_out_of_range_partitions: HashMap<TopicPartition, i64>, divergent_offsets: HashMap<TopicPartition, OffsetAndMetadata>, ) -> Self

Constructs a new ConsumerLogTruncationError with the fetch offsets and divergent offsets.

Arguments

• offset_out_of_range_partitions - The fetch offsets that were out of range
• divergent_offsets - The offsets where the consumer’s log diverged from the broker’s log

pub fn with_message( message: impl Into<String>, offset_out_of_range_partitions: HashMap<TopicPartition, i64>, divergent_offsets: HashMap<TopicPartition, OffsetAndMetadata>, ) -> Self

Constructs a new ConsumerLogTruncationError with a custom message.

Arguments

• message - The detail message
• offset_out_of_range_partitions - The fetch offsets that were out of range
• divergent_offsets - The offsets where the consumer’s log diverged from the broker’s log

pub fn offset_out_of_range_partitions(&self) -> &HashMap<TopicPartition, i64>

Get a map of the topic partitions and the respective out-of-range fetch offsets.

Returns

The out-of-range fetch offset per partition

pub fn divergent_offsets(&self) -> &HashMap<TopicPartition, OffsetAndMetadata>

Get the divergent offsets for the partitions which were truncated. For each partition, this is the first offset which is known to diverge from what the consumer read.

Note that there is no guarantee that this offset will be known. It is necessary to use Self::partitions to see the set of partitions that were truncated and then check for the presence of a divergent offset in this map.

Returns

The divergent offset per partition

pub fn partitions(&self) -> impl Iterator<Item = &TopicPartition>

Returns the set of partitions for which the offset was invalid.

Returns

The set of partitions with invalid offsets

Translation notes

Iterates the keys instead of copying them.

pub fn message(&self) -> &str

Returns the error message.

impl ConsumerLogTruncationError

pub fn source(&self) -> Option<&Error>

Returns the cause of this error: always None, as no constructor takes one.

Trait Implementations

impl Clone for ConsumerLogTruncationError

fn clone(&self) -> ConsumerLogTruncationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConsumerLogTruncationError

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

Formats the value using the given formatter.

impl Display for ConsumerLogTruncationError

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

Formats the value using the given formatter.

impl Error for ConsumerLogTruncationError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.