kacrab-protocol 0.1.0

Kafka wire protocol types — generated from upstream message schemas by `kacrab-codegen`.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

//! Error types for [`crate::version`].
//!
//! Two distinct failure modes, each a plain struct rather than an enum variant:
//! [`UnsupportedVersion`] (the negotiated range was empty / a decoder rejected an
//! unknown version) and [`UnsupportedFieldVersion`] (a field was set while
//! encoding a version that does not carry it). Context fields are always
//! populated.

/// API version negotiation produced no mutually-supported version, or a
/// generated decoder rejected an unknown version.
#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
#[error("unsupported version: api_key={api_key}, version={version}")]
#[non_exhaustive]
pub struct UnsupportedVersion {
    /// Kafka API key (numeric form).
    pub api_key: i16,
    /// The version that was rejected.
    pub version: i16,
}

impl UnsupportedVersion {
    /// Construct a new `UnsupportedVersion`.
    #[must_use]
    pub const fn new(api_key: i16, version: i16) -> Self {
        Self { api_key, version }
    }
}

/// A field was set while encoding a protocol version where that field does not
/// exist.
#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
#[error("unsupported field version: api_key={api_key}, field={field}, version={version}")]
#[non_exhaustive]
pub struct UnsupportedFieldVersion {
    /// Kafka API key (numeric form).
    pub api_key: i16,
    /// Generated Rust field name.
    pub field: &'static str,
    /// The version that does not carry this field.
    pub version: i16,
}

impl UnsupportedFieldVersion {
    /// Construct a new `UnsupportedFieldVersion`.
    #[must_use]
    pub const fn new(api_key: i16, field: &'static str, version: i16) -> Self {
        Self {
            api_key,
            field,
            version,
        }
    }
}