Skip to main content

kafka_client_engine/admin/describe_metadata_quorum/
outcome.rs

1//! Stable generated-free terminals for Admin `DescribeMetadataQuorum`.
2
3use core::fmt;
4
5use super::DescribeMetadataQuorumDescription;
6
7mod translate;
8
9pub(crate) use translate::translate_terminal;
10
11/// Stable delivery certainty independent of core and driver types.
12#[derive(Clone, Copy, Debug, Eq, PartialEq)]
13pub enum DescribeMetadataQuorumDeliveryStatus {
14    /// The failed call did not reach Kafka.
15    NotSent,
16    /// The failed call may have reached Kafka.
17    PossiblySent,
18}
19
20/// Exact top-level `DescribeQuorum` Kafka rejection.
21#[derive(Clone, Debug, Eq, PartialEq)]
22pub struct DescribeMetadataQuorumBrokerError {
23    pub(super) code: i16,
24    pub(super) message: Option<String>,
25    pub(super) message_truncated: bool,
26}
27
28impl DescribeMetadataQuorumBrokerError {
29    /// Returns Kafka's exact signed error code.
30    pub const fn code(&self) -> i16 {
31        self.code
32    }
33
34    /// Returns Kafka's nullable UTF-8-safe diagnostic prefix.
35    pub fn message(&self) -> Option<&str> {
36        self.message.as_deref()
37    }
38
39    /// Reports whether a present diagnostic was truncated.
40    pub const fn message_truncated(&self) -> bool {
41        self.message_truncated
42    }
43
44    /// Consumes this error into exact diagnostic parts.
45    pub fn into_parts(self) -> (i16, Option<String>, bool) {
46        (self.code, self.message, self.message_truncated)
47    }
48}
49
50/// Exact fixed metadata-partition Kafka rejection.
51#[derive(Clone, Debug, Eq, PartialEq)]
52pub struct DescribeMetadataQuorumPartitionError {
53    pub(super) code: i16,
54    pub(super) message: Option<String>,
55    pub(super) message_truncated: bool,
56}
57
58impl DescribeMetadataQuorumPartitionError {
59    /// Returns Kafka's exact signed error code.
60    pub const fn code(&self) -> i16 {
61        self.code
62    }
63
64    /// Returns Kafka's nullable UTF-8-safe diagnostic prefix.
65    pub fn message(&self) -> Option<&str> {
66        self.message.as_deref()
67    }
68
69    /// Reports whether a present diagnostic was truncated.
70    pub const fn message_truncated(&self) -> bool {
71        self.message_truncated
72    }
73
74    /// Consumes this error into exact diagnostic parts.
75    pub fn into_parts(self) -> (i16, Option<String>, bool) {
76        (self.code, self.message, self.message_truncated)
77    }
78}
79
80/// Stable whole-operation failure category.
81#[derive(Clone, Copy, Debug, Eq, PartialEq)]
82pub enum DescribeMetadataQuorumFailureKind {
83    /// The original absolute deadline elapsed.
84    DeadlineElapsed,
85    /// Driver admission rejected the prepared request.
86    DriverRejected,
87    /// Driver-owned transport execution failed.
88    Transport,
89    /// A valid response exceeded admitted retained capacity.
90    ResponseTooLarge,
91    /// The selected API version cannot represent required semantics.
92    Compatibility,
93    /// A response was malformed or could not be correlated.
94    InvalidResponse,
95}
96
97/// Whole-operation failure with authoritative delivery certainty.
98#[derive(Clone, Copy, Debug, Eq, PartialEq)]
99pub struct DescribeMetadataQuorumFailure {
100    pub(super) kind: DescribeMetadataQuorumFailureKind,
101    pub(super) delivery: DescribeMetadataQuorumDeliveryStatus,
102}
103
104impl DescribeMetadataQuorumFailure {
105    /// Returns the stable failure category.
106    pub const fn kind(self) -> DescribeMetadataQuorumFailureKind {
107        self.kind
108    }
109
110    /// Returns authoritative delivery certainty.
111    pub const fn delivery(self) -> DescribeMetadataQuorumDeliveryStatus {
112        self.delivery
113    }
114}
115
116/// Exactly one engine-owned terminal decision.
117#[derive(Clone, Debug, Eq, PartialEq)]
118pub enum DescribeMetadataQuorumOutcome {
119    /// Kafka described the fixed metadata quorum.
120    Described(DescribeMetadataQuorumDescription),
121    /// Kafka rejected the complete request.
122    BrokerRejected(DescribeMetadataQuorumBrokerError),
123    /// Kafka rejected the fixed metadata partition.
124    PartitionRejected(DescribeMetadataQuorumPartitionError),
125    /// Execution failed outside an exact Kafka rejection.
126    Failed(DescribeMetadataQuorumFailure),
127}
128
129/// Failure to observe a named completion.
130#[derive(Clone, Copy, Debug, Eq, PartialEq)]
131pub enum DescribeMetadataQuorumObserverError {
132    /// This linear observer already consumed its terminal.
133    AlreadyObserved,
134    /// The observer generation is no longer live.
135    Stale,
136}
137
138impl fmt::Display for DescribeMetadataQuorumObserverError {
139    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
140        formatter.write_str(match self {
141            Self::AlreadyObserved => "Admin DescribeMetadataQuorum result was already observed",
142            Self::Stale => "Admin DescribeMetadataQuorum observer is stale",
143        })
144    }
145}
146
147impl std::error::Error for DescribeMetadataQuorumObserverError {}