Update the note on not serializing absolute offsets
commit2c225845bf3473fde5bbc16ec3e84f8257e832eb
authorAdithya Kumar <adithya@composewell.com>
dateMon 11 Sep 2023, 16:04 (3 years ago)
parent9c67608
core/src/Streamly/Internal/Data/Serialize/Type.hs+2−2
@@ -50,8 +50,8 @@ import GHC.Exts
5050-- IMPORTANT
5151-- =========
5252--
53−-- Don't ever serialize the offsets in the encoding. Serialize length instead.
54−-- Offsets are NOT stable.
53+-- Don't ever serialize the absolute offsets in the encoding. Serialize length
54+-- instead. Absolute offsets are NOT stable.
5555--
5656-- They will only work if the start offset of the Array when encoding and
5757-- decoding is the same. This is almost never the case.