Enum ClientError 

#[non_exhaustive]
pub enum ClientError {
    Connect {
        addr: SocketAddr,
        source: Error,
    },
    Tls {
        addr: SocketAddr,
        source: Error,
    },
    Sasl {
        addr: SocketAddr,
        source: OutboundSaslError,
    },
    Authentication {
        addr: SocketAddr,
        source: AuthenticationError,
    },
    Disconnected,
    InvalidConfig(String),
    InvalidArgument(String),
    TelemetryDisabled,
    Timeout(Time),
    IncompatibleVersion {
        api_key: i16,
        broker_min: i16,
        broker_max: i16,
        client_min: i16,
        client_max: i16,
    },
    Server {
        error_code: i16,
    },
    NoCoordinator {
        key: String,
    },
    Codec(ProtocolError),
    Io(Error),
}

Errors returned by Client, Connection, and the broker pool.

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.

Connect

Fields

addr: SocketAddr

source: Error

Tls

The TCP connection opened, but the TLS handshake failed before the peer gave a verdict, for example on EOF, a reset, or a close_notify alert. The caller can connect again. A rejection by the peer is ClientError::Authentication.

Fields

addr: SocketAddr

source: Error

Sasl

The SASL exchange failed after the TCP connection, and TLS if the protocol uses it, came up, and the broker did not reject the credentials. The stream failed, a frame was too large, or the broker sent an error code that is not an authentication error. The caller can connect again. A rejection by the broker is ClientError::Authentication.

Fields

addr: SocketAddr

source: OutboundSaslError

Authentication

The TLS peer or the SASL broker rejected authentication.

Kafka’s NetworkClient.processDisconnection stores this AuthenticationException for the node, and the client raises it from the next call without a retry. Do not evict and retry on this error.

Fields

addr: SocketAddr

source: AuthenticationError

Disconnected

InvalidConfig(String)

InvalidArgument(String)

An argument of a call is invalid, as Kafka’s clients throw an IllegalArgumentException.

TelemetryDisabled

The client does not push metrics (enable_metrics_push is false), so it has no client instance id. Kafka’s clients throw an IllegalStateException with this message from clientInstanceId.

Timeout(Time)

IncompatibleVersion

Fields

api_key: i16

broker_min: i16

broker_max: i16

client_min: i16

client_max: i16

Server

Fields

error_code: i16

NoCoordinator

Fields

key: String

Codec(ProtocolError)

Io(Error)

Implementations

impl ClientError

pub const fn is_authentication_failure(&self) -> bool

Whether the peer rejected authentication. Kafka raises such an AuthenticationException to the application without a retry.

Trait Implementations

impl Debug for ClientError

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

Formats the value using the given formatter.

impl Display for ClientError

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

Formats the value using the given formatter.

impl Error for ClientError

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

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ProtocolError> for ClientError

fn from(source: ProtocolError) -> Self

Converts to this type from the input type.