confluent_kafka/producer/
record_metadata.rs1use std::fmt;
20
21use crate::common::TopicPartition;
22use crate::common::record::internal::RecordBatch;
23
24#[derive(Clone, Debug)]
26#[doc(alias = "org.apache.kafka.clients.producer.RecordMetadata")]
27pub struct RecordMetadata {
28 offset: i64,
30 timestamp: i64,
37 serialized_key_size: i32,
39 serialized_value_size: i32,
41 topic_partition: TopicPartition,
43}
44
45impl RecordMetadata {
46 pub(crate) const INVALID_OFFSET: i64 = -1;
51
52 pub const UNKNOWN_PARTITION: i32 = -1;
54
55 #[doc(alias = "org.apache.kafka.clients.producer.RecordMetadata#RecordMetadata")]
66 pub fn new(
67 topic_partition: TopicPartition,
68 base_offset: i64,
69 batch_index: i32,
70 timestamp: i64,
71 serialized_key_size: i32,
72 serialized_value_size: i32,
73 ) -> Self {
74 let offset = if base_offset == -1 {
77 base_offset
78 } else {
79 base_offset + batch_index as i64
80 };
81 Self { offset, timestamp, serialized_key_size, serialized_value_size, topic_partition }
82 }
83
84 #[doc(alias = "org.apache.kafka.clients.producer.RecordMetadata#hasOffset")]
90 pub fn has_offset(&self) -> bool {
91 self.offset != RecordMetadata::INVALID_OFFSET
92 }
93
94 #[doc(alias = "org.apache.kafka.clients.producer.RecordMetadata#offset")]
101 pub fn offset(&self) -> i64 {
102 self.offset
103 }
104
105 #[doc(alias = "org.apache.kafka.clients.producer.RecordMetadata#hasTimestamp")]
111 pub fn has_timestamp(&self) -> bool {
112 self.timestamp != RecordBatch::NO_TIMESTAMP
113 }
114
115 #[doc(alias = "org.apache.kafka.clients.producer.RecordMetadata#timestamp")]
122 pub fn timestamp(&self) -> i64 {
123 self.timestamp
124 }
125
126 #[doc(alias = "org.apache.kafka.clients.producer.RecordMetadata#serializedKeySize")]
129 pub fn serialized_key_size(&self) -> i32 {
130 self.serialized_key_size
131 }
132
133 #[doc(alias = "org.apache.kafka.clients.producer.RecordMetadata#serializedValueSize")]
136 pub fn serialized_value_size(&self) -> i32 {
137 self.serialized_value_size
138 }
139
140 #[doc(alias = "org.apache.kafka.clients.producer.RecordMetadata#topic")]
142 pub fn topic(&self) -> &str {
143 self.topic_partition.topic()
144 }
145
146 #[doc(alias = "org.apache.kafka.clients.producer.RecordMetadata#partition")]
148 pub fn partition(&self) -> i32 {
149 self.topic_partition.partition()
150 }
151}
152
153impl fmt::Display for RecordMetadata {
154 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
155 write!(f, "{}@{}", self.topic_partition, self.offset)
156 }
157}
158
159#[cfg(test)]
160mod tests {
161 use super::*;
162
163 #[test]
165 #[doc(alias = "org.apache.kafka.clients.producer.RecordMetadataTest#testConstructionWithMissingBatchIndex")]
166 fn test_construction_with_missing_batch_index() {
167 let tp = TopicPartition::new("foo".to_string(), 0);
168 let timestamp = 2340234_i64;
169 let key_size = 3;
170 let value_size = 5;
171
172 let metadata = RecordMetadata::new(tp, -1, -1, timestamp, key_size, value_size);
173 assert_eq!("foo", metadata.topic());
174 assert_eq!(0, metadata.partition());
175 assert_eq!(timestamp, metadata.timestamp());
176 assert!(!metadata.has_offset());
177 assert_eq!(-1, metadata.offset());
178 assert_eq!(key_size, metadata.serialized_key_size());
179 assert_eq!(value_size, metadata.serialized_value_size());
180 }
181
182 #[test]
184 #[doc(alias = "org.apache.kafka.clients.producer.RecordMetadataTest#testConstructionWithBatchIndexOffset")]
185 fn test_construction_with_batch_index_offset() {
186 let tp = TopicPartition::new("foo".to_string(), 0);
187 let timestamp = 2340234_i64;
188 let key_size = 3;
189 let value_size = 5;
190 let base_offset = 15_i64;
191 let batch_index = 3;
192
193 let metadata = RecordMetadata::new(tp, base_offset, batch_index, timestamp, key_size, value_size);
194 assert_eq!("foo", metadata.topic());
195 assert_eq!(0, metadata.partition());
196 assert_eq!(timestamp, metadata.timestamp());
197 assert_eq!(base_offset + batch_index as i64, metadata.offset());
198 assert_eq!(key_size, metadata.serialized_key_size());
199 assert_eq!(value_size, metadata.serialized_value_size());
200 }
201
202 #[test]
203 fn test_record_metadata_with_offset() {
204 let tp = TopicPartition::new("test-topic".to_string(), 0);
205 let metadata = RecordMetadata::new(tp, 100, 5, 1234567890, 10, 20);
206 assert!(metadata.has_offset());
207 assert_eq!(metadata.offset(), 105);
208 assert!(metadata.has_timestamp());
209 assert_eq!(metadata.timestamp(), 1234567890);
210 assert_eq!(metadata.serialized_key_size(), 10);
211 assert_eq!(metadata.serialized_value_size(), 20);
212 assert_eq!(metadata.topic(), "test-topic");
213 assert_eq!(metadata.partition(), 0);
214 }
215
216 #[test]
217 fn test_record_metadata_unknown_offset() {
218 let tp = TopicPartition::new("test-topic".to_string(), 0);
219 let metadata = RecordMetadata::new(tp, -1, 5, RecordBatch::NO_TIMESTAMP, -1, -1);
220 assert!(!metadata.has_offset());
221 assert_eq!(metadata.offset(), -1);
222 assert!(!metadata.has_timestamp());
223 }
224
225 #[test]
226 fn test_record_metadata_display() {
227 let tp = TopicPartition::new("test-topic".to_string(), 3);
228 let metadata = RecordMetadata::new(tp, 42, 0, 0, 0, 0);
229 assert_eq!(metadata.to_string(), "test-topic-3@42");
230 }
231}