Skip to main content

KafkaError

Enum KafkaError 

Source
#[non_exhaustive]
pub enum KafkaError { Connect(Box<dyn StdError + Send + Sync>), Publish(Box<dyn StdError + Send + Sync>), Subscribe(Box<dyn StdError + Send + Sync>), Consume(Box<dyn StdError + Send + Sync>), NotConnected { topic: String, }, Closed { topic: String, }, InvalidOptions(String), TransactionBusy { id: String, }, NoTransaction { id: String, }, }
Expand description

Errors returned by KafkaBroker and the types it hands out.

Underlying rdkafka errors are boxed as sources so the client library does not leak into this crate’s public API surface.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Connect(Box<dyn StdError + Send + Sync>)

Creating a client failed or the cluster was unreachable during the connect probe.

§

Publish(Box<dyn StdError + Send + Sync>)

Publishing a message failed or the broker did not confirm its delivery.

§

Subscribe(Box<dyn StdError + Send + Sync>)

Creating a consumer or subscribing it to its topic failed.

§

Consume(Box<dyn StdError + Send + Sync>)

Receiving a delivery from an open consumer failed.

§

NotConnected

A KafkaRetryPublisher was used before its broker connected.

Only the early publisher can report this: it is the one handle minted before Broker::connect, for builder-time wiring that needs a live publisher (retry_via). Everything on the policy path pairs with the connected broker, so “not connected” is not representable there.

Fields

§topic: String

The topic the operation targeted.

§

Closed

A handle aliasing the connection was used after the broker shut down.

The lifecycle ladder makes misuse through the owner’s handle a compile error: ConnectedBroker::shutdown consumes the connected broker. Publishers paired off it earlier, and subscriptions still open, keep aliasing the closed connection, so their operations report this instead of silently succeeding against a dead connection.

Fields

§topic: String

The topic the operation targeted, or the transactional id of a transaction control call.

§

InvalidOptions(String)

The requested combination of options cannot be executed.

The message names the offending option and the remediation.

§

TransactionBusy

begin_transaction found a transaction already open on this publisher.

One producer runs one transaction at a time, so a second begin means two flows share one publisher; erroring beats silently merging their messages into one transaction. Concurrent transactional flows need distinct publishers - one per partition via TransactionalPartitions, or distinct explicit ids.

Fields

§id: String

The transactional id of the publisher that already has an open transaction.

§

NoTransaction

commit or abort was called with no transaction open on this publisher.

Fields

§id: String

The transactional id of the publisher the call was made on.

Trait Implementations§

Source§

impl Debug for KafkaError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for KafkaError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for KafkaError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more