Skip to content

Commit

Permalink
Add a note about byte ordering
Browse files Browse the repository at this point in the history
  • Loading branch information
adithyaov committed Jul 25, 2023
1 parent b2f6356 commit 85d2eb3
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions core/src/Streamly/Internal/Data/Serialize.hs
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ data Size a
-- deserializes the boxed type from the mutable byte array. The write operation
-- 'serialize' serializes the boxed type to the mutable byte array.
--
-- IMPORTANT: The serialized data's byte ordering is not normalized, which means
-- it remains the same as the machine's byte order where the function is
-- executed. Consequently, it may not be compatible across machines with
-- different byte ordering.
--
-- 'Serialize' contains enough information to serialize and deserialize variable
-- length types.
--
Expand Down

0 comments on commit 85d2eb3

Please sign in to comment.