Struct KafkaError 

pub struct KafkaError { /* private fields */ }

Base Kafka error with common fields shared by all error types.

Corresponds to Java’s KafkaException / ApiException base class. Contains the protocol error code and an optional custom message — exactly the state Java’s KafkaException carries. Fatality is NOT state here: like Java, it is derived from the error’s identity, see request_utils::RequestUtils::is_fatal_error.

Specific error types (e.g., TopicAuthorizationError) embed this struct and add their own fields, mirroring Java’s error subclasses.

Do not confuse this with Error, the flat enum that wraps it — or with that enum’s KafkaError variant, which holds exactly one of these and nothing else.

Examples

use confluent_kafka::common::Error;

let err = Error::kafka_message_source("send failed", Error::timeout("expired"));
let base = err.kafka_error().expect("a bare Kafka error embeds a KafkaError");
assert_eq!(base.message(), "send failed");
assert_eq!(base.source().map(Error::message), Some("expired"));

Classification lives on Error, which wraps this type — Java’s KafkaException has no isRetriable() either:

use confluent_kafka::common::Error;

assert!(Error::timeout("expired").is_retriable_error());
assert!(!Error::kafka().is_retriable_error());

Implementations

impl KafkaError

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

The underlying cause, if any. Mirrors Java’s getCause().

pub fn message(&self) -> &str

The error message. Returns the custom message if set, otherwise the default message from the error code.

Trait Implementations

impl Clone for KafkaError

fn clone(&self) -> KafkaError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KafkaError

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

Formats the value using the given formatter.

impl Display for KafkaError

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

Formats the value using the given formatter.

impl Error for KafkaError

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

Wired to the stored source. This impl used to be empty, so source() answered None even when a cause was present — Java’s KafkaException(String, Throwable) keeps it.

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.