Enum ConsumerError 

#[non_exhaustive]
pub enum ConsumerError {
    Client(ClientError),
    Protocol(ProtocolError),
    RebalanceFailed(String),
    RebalanceListenerFailed(String),
    InvalidConfig(String),
    StartupAfterJoin(Box<ConsumerError>),
    NotSubscribed,
    IllegalState(String),
    InvalidArgument(String),
    InvalidTopic(String),
    Wakeup,
    InvalidGroupId,
    Timeout {
        message: String,
        cause: Option<Box<ConsumerError>>,
    },
    InvalidOffset(i64),
    NoCurrentAssignment {
        topic: String,
        partition: i32,
    },
    RetriableCommitFailed(Box<ConsumerError>),
    CommitInvalid,
    CoordinatorUnavailable,
    LogTruncation {
        topic: String,
        partition: i32,
        fetch_offset: i64,
        safe_offset: i64,
    },
    Server(i16),
    GroupAuthorizationFailed(String),
    TopicAuthorizationFailed(BTreeSet<String>),
    OffsetFetchFailed(i16),
    FencedInstanceId(String),
    CommitFailed,
    RebalanceInProgress(String),
    NoOffsetForPartition(BTreeSet<(String, i32)>),
}

Errors returned by Consumer.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Client(ClientError)

Protocol(ProtocolError)

RebalanceFailed(String)

RebalanceListenerFailed(String)

A rebalance listener callback failed. Kafka’s poll throws a KafkaException with the cause.

InvalidConfig(String)

A builder setting is not valid. Kafka’s ConfigException.

StartupAfterJoin(Box<ConsumerError>)

NotSubscribed

IllegalState(String)

InvalidArgument(String)

An argument of a call is not valid. Kafka’s IllegalArgumentException.

InvalidTopic(String)

The broker answered INVALID_TOPIC_EXCEPTION for the topic. Kafka’s InvalidTopicException.

Wakeup

WakeupHandle::wakeup woke the call. Kafka’s WakeupException.

InvalidGroupId

The call needs a group, and the consumer has no group id. Kafka’s InvalidGroupIdException.

Timeout

A call did not complete before its timeout. Kafka’s TimeoutException.

cause is the last retriable error when a retry loop ran out of time, as Kafka’s CommitRequestManager.maybeWrapAsTimeoutException wraps it. It is None when the call ran out of time while it waited.

Fields

message: String

cause: Option<Box<ConsumerError>>

InvalidOffset(i64)

NoCurrentAssignment

The call names a partition that the consumer does not own. Kafka’s SubscriptionState.assignedState raises IllegalStateException.

Fields

topic: String

partition: i32

RetriableCommitFailed(Box<ConsumerError>)

An asynchronous commit failed with a retriable error. A later commit can succeed. Kafka’s consumer gives RetriableCommitFailedException to the OffsetCommitCallback.

CommitInvalid

CoordinatorUnavailable

LogTruncation

Fields

topic: String

partition: i32

fetch_offset: i64

safe_offset: i64

Server(i16)

GroupAuthorizationFailed(String)

The coordinator answered GROUP_AUTHORIZATION_FAILED (30) for the group. Kafka’s consumer raises GroupAuthorizationException.

TopicAuthorizationFailed(BTreeSet<String>)

The coordinator answered TOPIC_AUTHORIZATION_FAILED (29) for partitions of these topics. Kafka’s consumer raises TopicAuthorizationException.

OffsetFetchFailed(i16)

An OffsetFetch response carried an error code that Kafka’s consumer does not retry.

FencedInstanceId(String)

The coordinator answered FENCED_INSTANCE_ID (82) for this group.instance.id, because another consumer joined with the same id. poll returns this error once. The next poll joins the group again. Kafka’s consumer raises FencedInstanceIdException.

CommitFailed

A commit found that the consumer is not part of an active group: a fatal coordinator error removed the member and no poll joined the group again yet, or the coordinator task stopped. Kafka’s consumer raises CommitFailedException.

RebalanceInProgress(String)

The coordinator answered ILLEGAL_GENERATION (22), UNKNOWN_MEMBER_ID (25) or FENCED_INSTANCE_ID (82) while the group was still PREPARING_REBALANCE, or REBALANCE_IN_PROGRESS (27). Kafka’s ConsumerCoordinator.OffsetCommitResponseHandler raises RebalanceInProgressException for these, and commitOffsetsSync does not retry: the offsets are not committed, and the caller must call poll() to finish the rebalance before it commits again.

NoOffsetForPartition(BTreeSet<(String, i32)>)

A partition has no committed offset and auto.offset.reset = none. Kafka never auto-resets under none (SubscriptionState.resetInitializingPositions); it raises NoOffsetForPartitionException from poll() and position() instead.

Trait Implementations

impl Debug for ConsumerError

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

Formats the value using the given formatter.

impl Display for ConsumerError

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

Formats the value using the given formatter.

impl Error for ConsumerError

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.

impl From<ClientError> for ConsumerError

fn from(source: ClientError) -> Self

Converts to this type from the input type.

impl From<ProtocolError> for ConsumerError

fn from(source: ProtocolError) -> Self

Converts to this type from the input type.