Add comment on GreedyBytes.

PointOneNav · Apr 10, 2024 · 64a0126 · 64a0126
1 parent 715843d
commit 64a0126
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/python/fusion_engine_client/messages/internal/playback_logging.py b/python/fusion_engine_client/messages/internal/playback_logging.py
@@ -38,6 +38,8 @@ def pack(self, buffer: bytes = None, offset: int = 0, return_buffer: bool = True
         return PackedDataToBuffer(packed_data, buffer, offset, return_buffer)
 
     def unpack(self, buffer: bytes, offset: int = 0, message_version: int = MessagePayload._UNSPECIFIED_VERSION) -> int:
+        # NOTE: Since this message does no capture the expected data size, the Construct relies on the size of the Python
+        # `buffer` to infer the size of the data. This is the behavior of @ref GreedyBytes.
         parsed = self.DataWrapperMessageConstruct.parse(buffer[offset:])
         self.unpack_timestamp(parsed.time_stamp_data)
         self.data_type = parsed.data_type