on master help sign in
Add a note about byte ordering
commitafd848edb0a639117565dcff828618bc0c127cd8 authorAdithya Kumar <adithya@composewell.com> dateTue 25 Jul 2023, 12:42 (3 years ago) parent58b86c5
1 file changed+5
core/src/Streamly/Internal/Data/Serialize.hs+5
core/src/Streamly/Internal/Data/Serialize.hs+5
@@ -36,6 +36,11 @@ data Size a
3636-- deserializes the boxed type from the mutable byte array. The write operation
3737-- 'serialize' serializes the boxed type to the mutable byte array.
3838--
39+-- IMPORTANT: The serialized data's byte ordering is not normalized, which means
40+-- it remains the same as the machine's byte order where the function is
41+-- executed. Consequently, it may not be compatible across machines with
42+-- different byte ordering.
43+--
3944-- 'Serialize' contains enough information to serialize and deserialize variable
4045-- length types.
4146--