Add clarifying comment

dfinity · Oct 2, 2023 · a75a17c · a75a17c
1 parent 4e3de2f
commit a75a17c
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/ic-transport-types/src/request_id.rs b/ic-transport-types/src/request_id.rs
@@ -350,6 +350,8 @@ impl SerializeStruct for StructSerializer {
 impl SerializeMap for StructSerializer {
     type Ok = Option<Sha256Hash>;
     type Error = RequestIdError;
+    // This implementation naïvely assumes serialize_key is called before serialize_value, with no checks.
+    // SerializeMap's documentation states that such a case is 'allowed to panic or produce bogus results.'
     fn serialize_key<T: ?Sized>(&mut self, key: &T) -> Result<(), Self::Error>
     where
         T: Serialize,