kafrust_protocol/api/
describe_acls.rs

1use crate::codec::{Decoder, Encoder};
2use crate::error::Result;
3use crate::header::RequestHeader;
4
5pub const API_KEY: i16 = 29;
6
7#[derive(Debug, Clone, PartialEq, Eq)]
8pub struct DescribeAclsRequestV1 {
9    pub correlation_id: i32,
10    pub client_id: Option<String>,
11    pub resource_type_filter: i8,
12    pub resource_name_filter: Option<String>,
13    pub pattern_type_filter: i8,
14    pub principal_filter: Option<String>,
15    pub host_filter: Option<String>,
16    pub operation: i8,
17    pub permission_type: i8,
18}
19
20impl DescribeAclsRequestV1 {
21    pub fn encode(&self) -> Result<Vec<u8>> {
22        let mut encoder = Encoder::new();
23        RequestHeader {
24            api_key: API_KEY,
25            api_version: 1,
26            correlation_id: self.correlation_id,
27            client_id: self.client_id.clone(),
28        }
29        .encode_v1(&mut encoder)?;
30        encoder.write_i8(self.resource_type_filter);
31        encoder.write_nullable_string(self.resource_name_filter.as_deref())?;
32        encoder.write_i8(self.pattern_type_filter);
33        encoder.write_nullable_string(self.principal_filter.as_deref())?;
34        encoder.write_nullable_string(self.host_filter.as_deref())?;
35        encoder.write_i8(self.operation);
36        encoder.write_i8(self.permission_type);
37        Ok(encoder.into_bytes())
38    }
39}
40
41#[derive(Debug, Clone, PartialEq, Eq)]
42pub struct DescribeAclsResponseV1 {
43    pub throttle_time_ms: i32,
44    pub error_code: i16,
45    pub error_message: Option<String>,
46    pub resources: Vec<DescribeAclsResourceV1>,
47}
48
49impl DescribeAclsResponseV1 {
50    pub fn decode_body(decoder: &mut Decoder<'_>) -> Result<Self> {
51        Ok(Self {
52            throttle_time_ms: decoder.read_i32()?,
53            error_code: decoder.read_i16()?,
54            error_message: decoder.read_nullable_string()?,
55            resources: decoder
56                .read_array("describe ACL resources", DescribeAclsResourceV1::decode)?
57                .unwrap_or_default(),
58        })
59    }
60}
61
62#[derive(Debug, Clone, PartialEq, Eq)]
63pub struct DescribeAclsResourceV1 {
64    pub resource_type: i8,
65    pub resource_name: String,
66    pub pattern_type: i8,
67    pub acls: Vec<DescribeAclsEntryV1>,
68}
69
70impl DescribeAclsResourceV1 {
71    fn decode(decoder: &mut Decoder<'_>) -> Result<Self> {
72        Ok(Self {
73            resource_type: decoder.read_i8()?,
74            resource_name: decoder.read_string()?,
75            pattern_type: decoder.read_i8()?,
76            acls: decoder
77                .read_array("describe ACL entries", DescribeAclsEntryV1::decode)?
78                .unwrap_or_default(),
79        })
80    }
81}
82
83#[derive(Debug, Clone, PartialEq, Eq)]
84pub struct DescribeAclsEntryV1 {
85    pub principal: String,
86    pub host: String,
87    pub operation: i8,
88    pub permission_type: i8,
89}
90
91impl DescribeAclsEntryV1 {
92    fn decode(decoder: &mut Decoder<'_>) -> Result<Self> {
93        Ok(Self {
94            principal: decoder.read_string()?,
95            host: decoder.read_string()?,
96            operation: decoder.read_i8()?,
97            permission_type: decoder.read_i8()?,
98        })
99    }
100}
101
102#[cfg(test)]
103#[allow(clippy::unwrap_used)]
104mod tests {
105    use super::{DescribeAclsRequestV1, DescribeAclsResponseV1, API_KEY};
106    use crate::codec::{Decoder, Encoder};
107
108    #[test]
109    fn encodes_describe_acls_v1_request() {
110        let request = DescribeAclsRequestV1 {
111            correlation_id: 17,
112            client_id: Some("kafrust".to_owned()),
113            resource_type_filter: 2,
114            resource_name_filter: Some("orders".to_owned()),
115            pattern_type_filter: 3,
116            principal_filter: Some("User:alice".to_owned()),
117            host_filter: Some("*".to_owned()),
118            operation: 3,
119            permission_type: 1,
120        };
121
122        let bytes = request.encode().unwrap();
123        assert_eq!(&bytes[0..4], &[0, API_KEY as u8, 0, 1]);
124        assert_eq!(&bytes[4..8], &[0, 0, 0, 17]);
125        assert_eq!(bytes.last(), Some(&1));
126    }
127
128    #[test]
129    fn decodes_describe_acls_v1_response() {
130        let mut bytes = Encoder::new();
131        bytes.write_i32(7);
132        bytes.write_i16(0);
133        bytes.write_nullable_string(None).unwrap();
134        bytes.write_i32(1);
135        bytes.write_i8(2);
136        bytes.write_string("orders").unwrap();
137        bytes.write_i8(3);
138        bytes.write_i32(1);
139        bytes.write_string("User:alice").unwrap();
140        bytes.write_string("*").unwrap();
141        bytes.write_i8(3);
142        bytes.write_i8(1);
143        let bytes = bytes.into_bytes();
144        let mut decoder = Decoder::new(&bytes);
145
146        let response = DescribeAclsResponseV1::decode_body(&mut decoder).unwrap();
147
148        assert_eq!(response.throttle_time_ms, 7);
149        assert_eq!(response.resources[0].resource_name, "orders");
150        assert_eq!(response.resources[0].pattern_type, 3);
151        assert_eq!(response.resources[0].acls[0].principal, "User:alice");
152        assert_eq!(response.resources[0].acls[0].operation, 3);
153        assert!(decoder.is_empty());
154    }
155}
kafrust_protocol/api/describe_acls.rs

kafrust_protocol/api/
describe_acls.rs
