Enum ProtocolError 

#[non_exhaustive]
pub enum ProtocolError {
    Primitive(PrimitiveError),
    Bytes(BytesError),
    String(StringError),
    Uuid(UuidError),
    Tagged(TaggedFieldError),
    Crc(CrcMismatch),
    Frame(FrameError),
    Record(RecordError),
    Compression(CompressionError),
    Version(UnsupportedVersion),
    FieldVersion(UnsupportedFieldVersion),
}

Crate-wide error facade. Every module error converts in via #[from].

Why a facade and not a single big enum?

Module errors stay narrow — callers that only deal with primitives won’t be forced to match a RecordError variant they can’t produce. The facade only widens at the boundary where errors need to flow uniformly (e.g. the generated message decoders).

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.

Primitive(PrimitiveError)

Primitive int / varint / array-length read failed.

Bytes(BytesError)

Length-prefixed raw bytes read/write failed.

String(StringError)

KafkaString read/write failed (length, UTF-8, null marker).

Uuid(UuidError)

KafkaUuid parse failed.

Tagged(TaggedFieldError)

Tagged-fields section is malformed (out-of-order tag, bad size).

Crc(CrcMismatch)

CRC32C check failed on a record batch.

Frame(FrameError)

TCP frame length prefix is invalid or oversized.

Record(RecordError)

Record batch decode failed (CRC, magic, length, record count).

Compression(CompressionError)

Compression codec dispatch / encode / decode failed.

Version(UnsupportedVersion)

API key / version negotiation failed.

FieldVersion(UnsupportedFieldVersion)

A generated message field was set for a version where it is absent.

Trait Implementations

impl Debug for ProtocolError

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

Formats the value using the given formatter.

impl Display for ProtocolError

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

Formats the value using the given formatter.

impl Error for ProtocolError

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<BytesError> for ProtocolError

fn from(source: BytesError) -> Self

Converts to this type from the input type.

impl From<CompressionError> for ProtocolError

fn from(source: CompressionError) -> Self

Converts to this type from the input type.

impl From<CrcMismatch> for ProtocolError

fn from(source: CrcMismatch) -> Self

Converts to this type from the input type.

impl From<FrameError> for ProtocolError

fn from(source: FrameError) -> Self

Converts to this type from the input type.

impl From<PrimitiveError> for ProtocolError

fn from(source: PrimitiveError) -> Self

Converts to this type from the input type.

impl From<RecordError> for ProtocolError

fn from(source: RecordError) -> Self

Converts to this type from the input type.

impl From<StringError> for ProtocolError

fn from(source: StringError) -> Self

Converts to this type from the input type.

impl From<TaggedFieldError> for ProtocolError

fn from(source: TaggedFieldError) -> Self

Converts to this type from the input type.

impl From<UnsupportedFieldVersion> for ProtocolError

fn from(source: UnsupportedFieldVersion) -> Self

Converts to this type from the input type.

impl From<UnsupportedVersion> for ProtocolError

fn from(source: UnsupportedVersion) -> Self

Converts to this type from the input type.

impl From<UuidError> for ProtocolError

fn from(source: UuidError) -> Self

Converts to this type from the input type.