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        types::Boolean.encode(buf, &self.include_cluster_authorized_operations)?;
73        if version >= 1 {
74            types::Int8.encode(buf, &self.endpoint_type)?;
75        } else {
76            if self.endpoint_type != 1 {
77                bail!("A field is set that is not available on the selected protocol version");
78            }
79        }
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        Ok(())
91    }
92    fn compute_size(&self, version: i16) -> Result<usize> {
93        let mut total_size = 0;
94        total_size += types::Boolean.compute_size(&self.include_cluster_authorized_operations)?;
95        if version >= 1 {
96            total_size += types::Int8.compute_size(&self.endpoint_type)?;
97        } else {
98            if self.endpoint_type != 1 {
99                bail!("A field is set that is not available on the selected protocol version");
100            }
101        }
102        let num_tagged_fields = self.unknown_tagged_fields.len();
103        if num_tagged_fields > std::u32::MAX as usize {
104            bail!(
105                "Too many tagged fields to encode ({} fields)",
106                num_tagged_fields
107            );
108        }
109        total_size += types::UnsignedVarInt.compute_size(num_tagged_fields as u32)?;
110
111        total_size += compute_unknown_tagged_fields_size(&self.unknown_tagged_fields)?;
112        Ok(total_size)
113    }
114}
115
116#[cfg(feature = "broker")]
117impl Decodable for DescribeClusterRequest {
118    fn decode<B: ByteBuf>(buf: &mut B, version: i16) -> Result<Self> {
119        let include_cluster_authorized_operations = types::Boolean.decode(buf)?;
120        let endpoint_type = if version >= 1 {
121            types::Int8.decode(buf)?
122        } else {
123            1
124        };
125        let mut unknown_tagged_fields = BTreeMap::new();
126        let num_tagged_fields = types::UnsignedVarInt.decode(buf)?;
127        for _ in 0..num_tagged_fields {
128            let tag: u32 = types::UnsignedVarInt.decode(buf)?;
129            let size: u32 = types::UnsignedVarInt.decode(buf)?;
130            let unknown_value = buf.try_get_bytes(size as usize)?;
131            unknown_tagged_fields.insert(tag as i32, unknown_value);
132        }
133        Ok(Self {
134            include_cluster_authorized_operations,
135            endpoint_type,
136            unknown_tagged_fields,
137        })
138    }
139}
140
141impl Default for DescribeClusterRequest {
142    fn default() -> Self {
143        Self {
144            include_cluster_authorized_operations: false,
145            endpoint_type: 1,
146            unknown_tagged_fields: BTreeMap::new(),
147        }
148    }
149}
150
151impl Message for DescribeClusterRequest {
152    const VERSIONS: VersionRange = VersionRange { min: 0, max: 1 };
153    const DEPRECATED_VERSIONS: Option<VersionRange> = None;
154}
155
156impl HeaderVersion for DescribeClusterRequest {
157    fn header_version(version: i16) -> i16 {
158        2
159    }
160}
kafka_protocol/messages/describe_cluster_request.rs

kafka_protocol/messages/
describe_cluster_request.rs
