Skip to main content

kafka_client_engine/admin/delete_share_group_offsets/
outcome.rs

1//! Stable generated-free terminals for Admin `DeleteShareGroupOffsets`.
2
3use core::fmt;
4
5mod translate;
6
7pub(crate) use translate::translate_terminal;
8
9use super::DeleteShareGroupOffsetsBatch;
10
11/// Stable delivery certainty independent of core and driver types.
12#[derive(Clone, Copy, Debug, Eq, PartialEq)]
13pub enum DeleteShareGroupOffsetsDeliveryStatus {
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 Kafka rejection and its bounded diagnostic.
21#[derive(Clone, Debug, Eq, PartialEq)]
22pub struct DeleteShareGroupOffsetsBrokerError {
23    pub(super) throttle_time_ms: u32,
24    pub(super) code: i16,
25    pub(super) message: Option<String>,
26    pub(super) message_truncated: bool,
27}
28
29impl DeleteShareGroupOffsetsBrokerError {
30    /// Returns Kafka's nonnegative throttle observation.
31    pub const fn throttle_time_ms(&self) -> u32 {
32        self.throttle_time_ms
33    }
34
35    /// Returns Kafka's exact signed nonzero error code.
36    pub const fn code(&self) -> i16 {
37        self.code
38    }
39
40    /// Returns Kafka's optional bounded diagnostic.
41    pub fn message(&self) -> Option<&str> {
42        self.message.as_deref()
43    }
44
45    /// Reports whether the diagnostic was truncated at the retained-byte bound.
46    pub const fn message_truncated(&self) -> bool {
47        self.message_truncated
48    }
49
50    /// Consumes the rejection into exact stable parts.
51    pub fn into_parts(self) -> (u32, i16, Option<String>, bool) {
52        (
53            self.throttle_time_ms,
54            self.code,
55            self.message,
56            self.message_truncated,
57        )
58    }
59}
60
61/// Stable whole-operation failure category outside exact Kafka rejections.
62#[derive(Clone, Copy, Debug, Eq, PartialEq)]
63pub enum DeleteShareGroupOffsetsFailureKind {
64    /// The original public absolute deadline elapsed.
65    DeadlineElapsed,
66    /// Driver admission rejected the prepared request.
67    DriverRejected,
68    /// Driver-owned transport execution failed.
69    Transport,
70    /// Valid response facts exceeded admitted retained capacity.
71    ResponseTooLarge,
72    /// The selected API version cannot represent required semantics.
73    Compatibility,
74    /// A response was malformed or could not be normalized.
75    InvalidResponse,
76}
77
78/// Whole-operation failure with authoritative delivery certainty.
79#[derive(Clone, Copy, Debug, Eq, PartialEq)]
80pub struct DeleteShareGroupOffsetsFailure {
81    pub(super) kind: DeleteShareGroupOffsetsFailureKind,
82    pub(super) delivery: DeleteShareGroupOffsetsDeliveryStatus,
83}
84
85impl DeleteShareGroupOffsetsFailure {
86    /// Returns the stable failure category.
87    pub const fn kind(self) -> DeleteShareGroupOffsetsFailureKind {
88        self.kind
89    }
90
91    /// Returns authoritative delivery certainty.
92    pub const fn delivery(self) -> DeleteShareGroupOffsetsDeliveryStatus {
93        self.delivery
94    }
95}
96
97/// Exactly one engine-owned terminal decision.
98#[derive(Clone, Debug, Eq, PartialEq)]
99pub enum DeleteShareGroupOffsetsOutcome {
100    /// Kafka returned one result for every requested topic.
101    Deleted(DeleteShareGroupOffsetsBatch),
102    /// Kafka rejected the group-level operation.
103    BrokerRejected(DeleteShareGroupOffsetsBrokerError),
104    /// Execution failed outside an exact Kafka rejection.
105    Failed(DeleteShareGroupOffsetsFailure),
106}
107
108/// Failure to observe one named completion.
109#[derive(Clone, Copy, Debug, Eq, PartialEq)]
110pub enum DeleteShareGroupOffsetsObserverError {
111    /// This linear observer already consumed its terminal.
112    AlreadyObserved,
113    /// The observer generation is no longer live.
114    Stale,
115}
116
117impl fmt::Display for DeleteShareGroupOffsetsObserverError {
118    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
119        formatter.write_str(match self {
120            Self::AlreadyObserved => "Admin DeleteShareGroupOffsets result was already observed",
121            Self::Stale => "Admin DeleteShareGroupOffsets observer is stale",
122        })
123    }
124}
125
126impl std::error::Error for DeleteShareGroupOffsetsObserverError {}