confluent_kafka/consumer/
offset_and_metadata.rs1use std::fmt;
20use std::hash::{Hash, Hasher};
21
22use crate::common::Error;
23
24#[derive(Clone, Debug)]
29#[doc(alias = "org.apache.kafka.clients.consumer.OffsetAndMetadata")]
30pub struct OffsetAndMetadata {
31 offset: i64,
32 leader_epoch: Option<i32>,
35 metadata: String,
36}
37
38impl OffsetAndMetadata {
39 #[doc(alias = "org.apache.kafka.clients.consumer.OffsetAndMetadata#OffsetAndMetadata")]
55 pub fn new(offset: i64) -> Result<Self, Error> {
56 Self::with_leader_epoch_metadata(offset, None, String::new())
57 }
58
59 #[doc(alias = "org.apache.kafka.clients.consumer.OffsetAndMetadata#OffsetAndMetadata")]
75 pub fn with_metadata(offset: i64, metadata: impl Into<String>) -> Result<Self, Error> {
76 Self::with_leader_epoch_metadata(offset, None, metadata)
77 }
78
79 #[doc(alias = "org.apache.kafka.clients.consumer.OffsetAndMetadata#OffsetAndMetadata")]
96 pub fn with_leader_epoch_metadata(
97 offset: i64,
98 leader_epoch: Option<i32>,
99 metadata: impl Into<String>,
100 ) -> Result<Self, Error> {
101 if offset < 0 {
102 return Err(Error::local_illegal_argument("Invalid negative offset"));
103 }
104 Ok(Self { offset, leader_epoch, metadata: metadata.into() })
108 }
109
110 #[doc(alias = "org.apache.kafka.clients.consumer.OffsetAndMetadata#offset")]
112 pub fn offset(&self) -> i64 {
113 self.offset
114 }
115
116 #[doc(alias = "org.apache.kafka.clients.consumer.OffsetAndMetadata#metadata")]
122 pub fn metadata(&self) -> &str {
123 &self.metadata
124 }
125
126 #[doc(alias = "org.apache.kafka.clients.consumer.OffsetAndMetadata#leaderEpoch")]
135 pub fn leader_epoch(&self) -> Option<i32> {
136 match self.leader_epoch {
137 Some(e) if e >= 0 => Some(e),
138 _ => None,
139 }
140 }
141}
142
143impl PartialEq for OffsetAndMetadata {
144 fn eq(&self, other: &Self) -> bool {
145 self.offset == other.offset && self.metadata == other.metadata && self.leader_epoch() == other.leader_epoch()
148 }
149}
150
151impl Eq for OffsetAndMetadata {}
152
153impl Hash for OffsetAndMetadata {
154 fn hash<H: Hasher>(&self, state: &mut H) {
155 self.offset.hash(state);
156 self.metadata.hash(state);
157 self.leader_epoch().hash(state);
158 }
159}
160
161impl fmt::Display for OffsetAndMetadata {
162 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
166 let leader_epoch_str = match self.leader_epoch() {
167 Some(e) => e.to_string(),
168 None => "null".to_string(),
169 };
170 write!(
171 f,
172 "OffsetAndMetadata{{offset={}, leaderEpoch={}, metadata='{}'}}",
173 self.offset, leader_epoch_str, self.metadata
174 )
175 }
176}
177
178#[cfg(test)]
179mod tests {
180 use super::*;
181 use std::collections::hash_map::DefaultHasher;
182
183 fn hash_of(o: &OffsetAndMetadata) -> u64 {
184 let mut h = DefaultHasher::new();
185 o.hash(&mut h);
186 h.finish()
187 }
188
189 #[test]
190 fn test_simple_constructor() {
191 let o = OffsetAndMetadata::new(10).unwrap();
192 assert_eq!(o.offset(), 10);
193 assert_eq!(o.metadata(), "");
194 assert_eq!(o.leader_epoch(), None);
195 }
196
197 #[test]
198 fn test_new_metadata() {
199 let o = OffsetAndMetadata::with_metadata(10, "m").unwrap();
200 assert_eq!(o.metadata(), "m");
201 assert_eq!(o.leader_epoch(), None);
202 }
203
204 #[test]
205 fn test_new_leader_epoch_metadata() {
206 let o = OffsetAndMetadata::with_leader_epoch_metadata(10, Some(2), "m").unwrap();
207 assert_eq!(o.leader_epoch(), Some(2));
208 }
209
210 #[test]
211 #[doc(alias = "org.apache.kafka.clients.consumer.OffsetAndMetadataTest#testInvalidNegativeOffset")]
212 fn test_invalid_negative_offset() {
213 let err = OffsetAndMetadata::new(-1).unwrap_err();
214 assert!(err.message().contains("Invalid negative offset"));
215 }
216
217 #[test]
218 fn test_negative_leader_epoch_treated_as_none() {
219 let o = OffsetAndMetadata::with_leader_epoch_metadata(10, Some(-1), "m").unwrap();
220 assert_eq!(o.leader_epoch(), None);
221 }
222
223 #[test]
224 fn test_display() {
225 let o = OffsetAndMetadata::with_leader_epoch_metadata(10, Some(2), "m").unwrap();
226 assert_eq!(o.to_string(), "OffsetAndMetadata{offset=10, leaderEpoch=2, metadata='m'}");
227
228 let o = OffsetAndMetadata::new(10).unwrap();
229 assert_eq!(o.to_string(), "OffsetAndMetadata{offset=10, leaderEpoch=null, metadata=''}");
230 }
231
232 #[test]
233 #[doc(alias = "org.apache.kafka.clients.consumer.OffsetAndMetadataTest#testEqualsWithNullAndNegativeLeaderEpoch")]
234 fn test_equals_with_null_and_negative_leader_epoch() {
235 let with_none = OffsetAndMetadata::with_leader_epoch_metadata(100, None, "metadata").unwrap();
236 let with_neg = OffsetAndMetadata::with_leader_epoch_metadata(100, Some(-1), "metadata").unwrap();
237 assert_eq!(with_none, with_neg);
238 assert_eq!(hash_of(&with_none), hash_of(&with_neg));
239 }
240}