kafka_protocol/messages/
describe_cluster_request.rs

1//! DescribeClusterRequest
2//!
3//! See the schema for this message [here](https://github.com/apache/kafka/blob/trunk/clients/src/main/resources/common/message/DescribeClusterRequest.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-1
21#[non_exhaustive]
22#[derive(Debug, Clone, PartialEq)]
23pub struct DescribeClusterRequest {
24    /// Whether to include cluster authorized operations.
25    ///
26    /// Supported API versions: 0-1
27    pub include_cluster_authorized_operations: bool,
28
29    /// The endpoint type to describe. 1=brokers, 2=controllers.
30    ///
31    /// Supported API versions: 1
32    pub endpoint_type: i8,
33
34    /// Other tagged fields
35    pub unknown_tagged_fields: BTreeMap<i32, Bytes>,
36}
37
38impl DescribeClusterRequest {
39    /// Sets `include_cluster_authorized_operations` to the passed value.
40    ///
41    /// Whether to include cluster authorized operations.
42    ///
43    /// Supported API versions: 0-1
44    pub fn with_include_cluster_authorized_operations(mut self, value: bool) -> Self {
45        self.include_cluster_authorized_operations = value;
46        self
47    }
48    /// Sets `endpoint_type` to the passed value.
49    ///
50    /// The endpoint type to describe. 1=brokers, 2=controllers.
51    ///
52    /// Supported API versions: 1
53    pub fn with_endpoint_type(mut self, value: i8) -> Self {
54        self.endpoint_type = 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 DescribeClusterRequest {
71    fn encode<B: ByteBufMut>(&self, buf: &mut B, version: i16) -> Result<()> {
72        if version < 0 || version > 1 {
73            bail!("specified version not supported by this message type");
74        }
75        types::Boolean.encode(buf, &self.include_cluster_authorized_operations)?;
76        if version >= 1 {
77            types::Int8.encode(buf, &self.endpoint_type)?;
78        } else {
79            if self.endpoint_type != 1 {
80                bail!("A field is set that is not available on the selected protocol version");
81            }
82        }
83        let num_tagged_fields = self.unknown_tagged_fields.len();
84        if num_tagged_fields > std::u32::MAX as usize {
85            bail!(
86                "Too many tagged fields to encode ({} fields)",
87                num_tagged_fields
88            );
89        }
90        types::UnsignedVarInt.encode(buf, num_tagged_fields as u32)?;
91
92        write_unknown_tagged_fields(buf, 0.., &self.unknown_tagged_fields)?;
93        Ok(())
94    }
95    fn compute_size(&self, version: i16) -> Result<usize> {
96        let mut total_size = 0;
97        total_size += types::Boolean.compute_size(&self.include_cluster_authorized_operations)?;
98        if version >= 1 {
99            total_size += types::Int8.compute_size(&self.endpoint_type)?;
100        } else {
101            if self.endpoint_type != 1 {
102                bail!("A field is set that is not available on the selected protocol version");
103            }
104        }
105        let num_tagged_fields = self.unknown_tagged_fields.len();
106        if num_tagged_fields > std::u32::MAX as usize {
107            bail!(
108                "Too many tagged fields to encode ({} fields)",
109                num_tagged_fields
110            );
111        }
112        total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
113
114        total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
115        Ok(total_size)
116    }
117}
118
119#[cfg(feature = "broker")]
120impl Decodable for DescribeClusterRequest {
121    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
122        if version < 0 || version > 1 {
123            bail!("specified version not supported by this message type");
124        }
125        let include_cluster_authorized_operations = types::Boolean.decode(buf)?;
126        let endpoint_type = if version >= 1 {
127            types::Int8.decode(buf)?
128        } else {
129            1
130        };
131        let mut unknown_tagged_fields = BTreeMap::new();
132        let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
133        for _ in 0..num_tagged_fields {
134            let tag: u32 = types::UnsignedVarInt.decode(buf)?;
135            let size: u32 = types::UnsignedVarInt.decode(buf)?;
136            let unknown_value = buf.try_get_bytes(size as usize)?;
137            unknown_tagged_fields.insert(tag as i32, unknown_value);
138        }
139        Ok(Self {
140            include_cluster_authorized_operations,
141            endpoint_type,
142            unknown_tagged_fields,
143        })
144    }
145}
146
147impl Default for DescribeClusterRequest {
148    fn default() -> Self {
149        Self {
150            include_cluster_authorized_operations: false,
151            endpoint_type: 1,
152            unknown_tagged_fields: BTreeMap::new(),
153        }
154    }
155}
156
157impl Message for DescribeClusterRequest {
158    const VERSIONS: VersionRange = VersionRange { min: 0, max: 1 };
159    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
160}
161
162impl HeaderVersion for DescribeClusterRequest {
163    fn header_version(version: i16) -> i16 {
164        2
165    }
166}
kafka_protocol/messages/describe_cluster_request.rs

kafka_protocol/messages/
describe_cluster_request.rs
