kafka_protocol/messages/
controlled_shutdown_request.rs

1//! ControlledShutdownRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/ControlledShutdownRequest.json).
4// WARNING: the items of this module are generated and should not be edited directly
5#![allow(unused)]
6
7use std::borrow::Borrow;
8use std::collections::BTreeMap;
9
10use anyhow::{bail, Result};
11use bytes::Bytes;
12use uuid::Uuid;
13
14use crate::protocol::{
15    buf::{ByteBuf, ByteBufMut},
16    compute_unknown_tagged_fields_size, types, write_unknown_tagged_fields, Decodable, Decoder,
17    Encodable, Encoder, HeaderVersion, Message, StrBytes, VersionRange,
18};
19
20/// Valid versions: 0-3
21#[non_exhaustive]
22#[derive(Debug, Clone, PartialEq)]
23pub struct ControlledShutdownRequest {
24    /// The id of the broker for which controlled shutdown has been requested.
25    ///
26    /// Supported API versions: 0-3
27    pub broker_id: super::BrokerId,
28
29    /// The broker epoch.
30    ///
31    /// Supported API versions: 2-3
32    pub broker_epoch: i64,
33
34    /// Other tagged fields
35    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
36}
37
38impl ControlledShutdownRequest {
39    /// Sets `broker_id` to the passed value.
40    ///
41    /// The id of the broker for which controlled shutdown has been requested.
42    ///
43    /// Supported API versions: 0-3
44    pub fn with_broker_id(mut self, value: super::BrokerId) -> Self {
45        self.broker_id = value;
46        self
47    }
48    /// Sets `broker_epoch` to the passed value.
49    ///
50    /// The broker epoch.
51    ///
52    /// Supported API versions: 2-3
53    pub fn with_broker_epoch(mut self, value: i64) -> Self {
54        self.broker_epoch = value;
55        self
56    }
57    /// Sets unknown_tagged_fields to the passed value.
58    pub fn with_unknown_tagged_fields(mut self, value: BTreeMap<i32, Bytes>) -> Self {
59        self.unknown_tagged_fields = value;
60        self
61    }
62    /// Inserts an entry into unknown_tagged_fields.
63    pub fn with_unknown_tagged_field(mut self, key: i32, value: Bytes) -> Self {
64        self.unknown_tagged_fields.insert(key, value);
65        self
66    }
67}
68
69#[cfg(feature = "client")]
70impl Encodable for ControlledShutdownRequest {
71    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
72        if version < 0 || version > 3 {
73            bail!("specified version not supported by this message type");
74        }
75        types::Int32.encode(buf, &self.broker_id)?;
76        if version >= 2 {
77            types::Int64.encode(buf, &self.broker_epoch)?;
78        }
79        if version >= 3 {
80            let num_tagged_fields = self.unknown_tagged_fields.len();
81            if num_tagged_fields > std::u32::MAX as usize {
82                bail!(
83                    "Too many tagged fields to encode ({} fields)",
84                    num_tagged_fields
85                );
86            }
87            types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
88
89            write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
90        }
91        Ok(())
92    }
93    fn compute_size(&self, version: i16) -> Result<usize> {
94        let mut total_size = 0;
95        total_size += types::Int32.compute_size(&self.broker_id)?;
96        if version >= 2 {
97            total_size += types::Int64.compute_size(&self.broker_epoch)?;
98        }
99        if version >= 3 {
100            let num_tagged_fields = self.unknown_tagged_fields.len();
101            if num_tagged_fields > std::u32::MAX as usize {
102                bail!(
103                    "Too many tagged fields to encode ({} fields)",
104                    num_tagged_fields
105                );
106            }
107            total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
108
109            total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
110        }
111        Ok(total_size)
112    }
113}
114
115#[cfg(feature = "broker")]
116impl Decodable for ControlledShutdownRequest {
117    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
118        if version < 0 || version > 3 {
119            bail!("specified version not supported by this message type");
120        }
121        let broker_id = types::Int32.decode(buf)?;
122        let broker_epoch = if version >= 2 {
123            types::Int64.decode(buf)?
124        } else {
125            -1
126        };
127        let mut unknown_tagged_fields = BTreeMap::new();
128        if version >= 3 {
129            let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
130            for _ in 0..num_tagged_fields {
131                let tag: u32 = types::UnsignedVarInt.decode(buf)?;
132                let size: u32 = types::UnsignedVarInt.decode(buf)?;
133                let unknown_value = buf.try_get_bytes(size as usize)?;
134                unknown_tagged_fields.insert(tag as i32, unknown_value);
135            }
136        }
137        Ok(Self {
138            broker_id,
139            broker_epoch,
140            unknown_tagged_fields,
141        })
142    }
143}
144
145impl Default for ControlledShutdownRequest {
146    fn default() -> Self {
147        Self {
148            broker_id: (0).into(),
149            broker_epoch: -1,
150            unknown_tagged_fields: BTreeMap::new(),
151        }
152    }
153}
154
155impl Message for ControlledShutdownRequest {
156    const VERSIONS: VersionRange = VersionRange { min: 0, max: 3 };
157    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
158}
159
160impl HeaderVersion for ControlledShutdownRequest {
161    fn header_version(version: i16) -> i16 {
162        if version >= 3 {
163            2
164        } else {
165            if version == 0 {
166                0
167            } else {
168                1
169            }
170        }
171    }
172}
kafka_protocol/messages/controlled_shutdown_request.rs

kafka_protocol/messages/
controlled_shutdown_request.rs
