Enum Error 

pub enum Error {
    Connection(ConnectionError),
    Protocol(ProtocolError),
    Kafka(KafkaCode),
    Config(String),
    Consumer(ConsumerError),
    TopicPartitionError {
        topic_name: String,
        partition_id: i32,
        error_code: KafkaCode,
    },
    BrokerRequestError {
        broker: String,
        api_key: &'static str,
        source: Box<Self>,
    },
}

The crate’s primary error type, encompassing network, protocol, server-side and client-side errors.

Variants

Connection(ConnectionError)

Wrapper for connection-level errors.

Protocol(ProtocolError)

Wrapper for protocol encoding/decoding/version negotiation errors.

Kafka(KafkaCode)

Represents an error code returned by a Kafka broker.

Config(String)

Configuration-related error with a human message.

Consumer(ConsumerError)

Errors arising from the consumer high-level API.

TopicPartitionError

Error contextualized to a specific topic and partition.

Fields

topic_name: String

Topic name associated with the error.

partition_id: i32

Partition id associated with the error.

error_code: KafkaCode

The Kafka error code returned by the broker.

BrokerRequestError

Error from a broker request which preserves broker context for debugging.

Fields

broker: String

Broker host (host:port) where the request failed.

api_key: &'static str

The API key name for the failing request.

source: Box<Self>

The wrapped underlying error (source).

Implementations

impl Error

pub fn with_broker_context( self, broker: impl Into<String>, api_key: &'static str, ) -> Self

Wraps this error with broker request context (broker host and API key name).

pub fn is_retriable(&self) -> bool

Returns true if this error is likely transient and can be resolved by retrying.

pub fn is_connection_error(&self) -> bool

Returns true if this error originates from the connection/network layer.

pub fn is_protocol_error(&self) -> bool

Returns true if this error originates from the protocol layer.

pub fn is_consumer_error(&self) -> bool

Returns true if this error originates from the consumer layer.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<Arc<Error>> for Error

fn from(e: Arc<Self>) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.