use crate::clear::Clear; use crate::wire_format; use crate::zigzag::encode_zig_zag_32; use crate::zigzag::encode_zig_zag_64; use std::collections::hash_map; use std::collections::hash_map::DefaultHasher; use std::collections::HashMap; use std::default::Default; use std::hash::BuildHasherDefault; use std::hash::Hash; use std::hash::Hasher; use std::slice; /// Unknown value. /// /// See [`UnknownFields`](crate::UnknownFields) for the explanations. #[derive(Debug)] pub enum UnknownValue { /// 32-bit unknown (e. g. `fixed32` or `float`) Fixed32(u32), /// 64-bit unknown (e. g. `fixed64` or `double`) Fixed64(u64), /// Varint unknown (e. g. `int32` or `bool`) Varint(u64), /// Length-delimited unknown (e. g. `message` or `string`) LengthDelimited(Vec), } impl UnknownValue { /// Wire type for this unknown pub fn wire_type(&self) -> wire_format::WireType { self.get_ref().wire_type() } /// As ref pub fn get_ref<'s>(&'s self) -> UnknownValueRef<'s> { match *self { UnknownValue::Fixed32(fixed32) => UnknownValueRef::Fixed32(fixed32), UnknownValue::Fixed64(fixed64) => UnknownValueRef::Fixed64(fixed64), UnknownValue::Varint(varint) => UnknownValueRef::Varint(varint), UnknownValue::LengthDelimited(ref bytes) => UnknownValueRef::LengthDelimited(&bytes), } } /// Construct unknown value from `sint32` value. pub fn sint32(i: i32) -> UnknownValue { UnknownValue::Varint(encode_zig_zag_32(i) as u64) } /// Construct unknown value from `sint64` value. pub fn sint64(i: i64) -> UnknownValue { UnknownValue::Varint(encode_zig_zag_64(i)) } } /// Reference to unknown value. /// /// See [`UnknownFields`](crate::UnknownFields) for explanations. pub enum UnknownValueRef<'o> { /// 32-bit unknown Fixed32(u32), /// 64-bit unknown Fixed64(u64), /// Varint unknown Varint(u64), /// Length-delimited unknown LengthDelimited(&'o [u8]), } impl<'o> UnknownValueRef<'o> { /// Wire-type to serialize this unknown pub fn wire_type(&self) -> wire_format::WireType { match *self { UnknownValueRef::Fixed32(_) => wire_format::WireTypeFixed32, UnknownValueRef::Fixed64(_) => wire_format::WireTypeFixed64, UnknownValueRef::Varint(_) => wire_format::WireTypeVarint, UnknownValueRef::LengthDelimited(_) => wire_format::WireTypeLengthDelimited, } } } /// Field unknown values. /// /// See [`UnknownFields`](crate::UnknownFields) for explanations. #[derive(Clone, PartialEq, Eq, Debug, Default, Hash)] pub struct UnknownValues { /// 32-bit unknowns pub fixed32: Vec, /// 64-bit unknowns pub fixed64: Vec, /// Varint unknowns pub varint: Vec, /// Length-delimited unknowns pub length_delimited: Vec>, } impl UnknownValues { /// Add unknown value pub fn add_value(&mut self, value: UnknownValue) { match value { UnknownValue::Fixed64(fixed64) => self.fixed64.push(fixed64), UnknownValue::Fixed32(fixed32) => self.fixed32.push(fixed32), UnknownValue::Varint(varint) => self.varint.push(varint), UnknownValue::LengthDelimited(length_delimited) => { self.length_delimited.push(length_delimited) } }; } /// Iterate over unknown values pub fn iter<'s>(&'s self) -> UnknownValuesIter<'s> { UnknownValuesIter { fixed32: self.fixed32.iter(), fixed64: self.fixed64.iter(), varint: self.varint.iter(), length_delimited: self.length_delimited.iter(), } } } impl<'a> IntoIterator for &'a UnknownValues { type Item = UnknownValueRef<'a>; type IntoIter = UnknownValuesIter<'a>; fn into_iter(self) -> UnknownValuesIter<'a> { self.iter() } } /// Iterator over unknown values pub struct UnknownValuesIter<'o> { fixed32: slice::Iter<'o, u32>, fixed64: slice::Iter<'o, u64>, varint: slice::Iter<'o, u64>, length_delimited: slice::Iter<'o, Vec>, } impl<'o> Iterator for UnknownValuesIter<'o> { type Item = UnknownValueRef<'o>; fn next(&mut self) -> Option> { let fixed32 = self.fixed32.next(); if fixed32.is_some() { return Some(UnknownValueRef::Fixed32(*fixed32.unwrap())); } let fixed64 = self.fixed64.next(); if fixed64.is_some() { return Some(UnknownValueRef::Fixed64(*fixed64.unwrap())); } let varint = self.varint.next(); if varint.is_some() { return Some(UnknownValueRef::Varint(*varint.unwrap())); } let length_delimited = self.length_delimited.next(); if length_delimited.is_some() { return Some(UnknownValueRef::LengthDelimited(&length_delimited.unwrap())); } None } } /// Hold "unknown" fields in parsed message. /// /// Field may be unknown if it they are added in newer version of `.proto`. /// Unknown fields are stored in `UnknownFields` structure, so /// protobuf message could process messages without losing data. /// /// For example, in this operation: load from DB, modify, store to DB, /// even when working with older `.proto` file, new fields won't be lost. #[derive(Clone, PartialEq, Eq, Debug, Default)] pub struct UnknownFields { /// The map. // // `Option` is needed, because HashMap constructor performs allocation, // and very expensive. // // We use "default hasher" to make iteration order deterministic. // Which is used to make codegen output deterministic in presence of unknown fields // (e. g. file options are represented as unknown fields). // Using default hasher is suboptimal, because it makes unknown fields less safe. // Note, Google Protobuf C++ simply uses linear map (which can exploitable the same way), // and Google Protobuf Java uses tree map to store unknown fields // (which is more expensive than hashmap). // TODO: hide pub fields: Option>>>, } /// Very simple hash implementation of `Hash` for `UnknownFields`. /// Since map is unordered, we cannot put entry hashes into hasher, /// instead we summing hashes of entries. impl Hash for UnknownFields { fn hash(&self, state: &mut H) { if let Some(ref map) = self.fields { if !map.is_empty() { let mut hash: u64 = 0; for (k, v) in &**map { let mut entry_hasher = DefaultHasher::new(); Hash::hash(&(k, v), &mut entry_hasher); hash = hash.wrapping_add(entry_hasher.finish()); } Hash::hash(&map.len(), state); Hash::hash(&hash, state); } } } } impl UnknownFields { /// Empty unknown fields pub fn new() -> UnknownFields { Default::default() } fn init_map(&mut self) { if self.fields.is_none() { self.fields = Some(Default::default()); } } fn find_field<'a>(&'a mut self, number: &'a u32) -> &'a mut UnknownValues { self.init_map(); match self.fields.as_mut().unwrap().entry(*number) { hash_map::Entry::Occupied(e) => e.into_mut(), hash_map::Entry::Vacant(e) => e.insert(Default::default()), } } /// Add unknown fixed 32-bit pub fn add_fixed32(&mut self, number: u32, fixed32: u32) { self.find_field(&number).fixed32.push(fixed32); } /// Add unknown fixed 64-bit pub fn add_fixed64(&mut self, number: u32, fixed64: u64) { self.find_field(&number).fixed64.push(fixed64); } /// Add unknown varint pub fn add_varint(&mut self, number: u32, varint: u64) { self.find_field(&number).varint.push(varint); } /// Add unknown length delimited pub fn add_length_delimited(&mut self, number: u32, length_delimited: Vec) { self.find_field(&number) .length_delimited .push(length_delimited); } /// Add unknown value pub fn add_value(&mut self, number: u32, value: UnknownValue) { self.find_field(&number).add_value(value); } /// Remove unknown field by number pub fn remove(&mut self, field_number: u32) { if let Some(fields) = &mut self.fields { fields.remove(&field_number); } } /// Iterate over all unknowns pub fn iter<'s>(&'s self) -> UnknownFieldsIter<'s> { UnknownFieldsIter { entries: self.fields.as_ref().map(|m| m.iter()), } } /// Find unknown field by number pub fn get(&self, field_number: u32) -> Option<&UnknownValues> { match self.fields { Some(ref map) => map.get(&field_number), None => None, } } } impl Clear for UnknownFields { fn clear(&mut self) { if let Some(ref mut fields) = self.fields { fields.clear(); } } } impl<'a> IntoIterator for &'a UnknownFields { type Item = (u32, &'a UnknownValues); type IntoIter = UnknownFieldsIter<'a>; fn into_iter(self) -> UnknownFieldsIter<'a> { self.iter() } } /// Iterator over [`UnknownFields`](crate::UnknownFields) pub struct UnknownFieldsIter<'s> { entries: Option>, } impl<'s> Iterator for UnknownFieldsIter<'s> { type Item = (u32, &'s UnknownValues); fn next(&mut self) -> Option<(u32, &'s UnknownValues)> { match self.entries { Some(ref mut entries) => entries.next().map(|(&number, values)| (number, values)), None => None, } } } #[cfg(test)] mod test { use super::UnknownFields; use std::collections::hash_map::DefaultHasher; use std::hash::Hash; use std::hash::Hasher; #[test] fn unknown_fields_hash() { let mut unknown_fields_1 = UnknownFields::new(); let mut unknown_fields_2 = UnknownFields::new(); // Check field order is not important unknown_fields_1.add_fixed32(10, 222); unknown_fields_1.add_fixed32(10, 223); unknown_fields_1.add_fixed64(14, 224); unknown_fields_2.add_fixed32(10, 222); unknown_fields_2.add_fixed64(14, 224); unknown_fields_2.add_fixed32(10, 223); fn hash(unknown_fields: &UnknownFields) -> u64 { let mut hasher = DefaultHasher::new(); Hash::hash(unknown_fields, &mut hasher); hasher.finish() } assert_eq!(hash(&unknown_fields_1), hash(&unknown_fields_2)); } #[test] fn unknown_fields_iteration_order_deterministic() { let mut u_1 = UnknownFields::new(); let mut u_2 = UnknownFields::new(); for u in &mut [&mut u_1, &mut u_2] { u.add_fixed32(10, 20); u.add_varint(30, 40); u.add_fixed64(50, 60); u.add_length_delimited(70, Vec::new()); u.add_varint(80, 90); u.add_fixed32(11, 22); u.add_fixed64(33, 44); } let items_1: Vec<_> = u_1.iter().collect(); let items_2: Vec<_> = u_2.iter().collect(); assert_eq!(items_1, items_2); } }