kafka_protocol/messages/
renew_delegation_token_request.rs

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