Skip to content

Commit

Permalink
Add some module level notes to ToBytes
Browse files Browse the repository at this point in the history
  • Loading branch information
harendra-kumar committed Aug 19, 2023
1 parent 2e53b60 commit a819eb7
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions core/src/Streamly/Internal/Serialize/ToBytes.hs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@
-- Portability : GHC
--
-- Encode Haskell data types to byte streams.
--
-- The primary purpose of this module is to serialize primitive Haskell types
-- to streams for convenient byte by byte processing when such a need arises.
--
-- It would be inefficient to use this to build byte streams from algebraic
-- data types. For general serialization of ADTs please use the Serialize type
-- class instances. The fastest way to convert general Haskell types to byte
-- streams is to serialize them to an array and then stream the array.

-- XXX remove unit, bool, ordering, and the type class as well

module Streamly.Internal.Serialize.ToBytes
(
Expand Down

0 comments on commit a819eb7

Please sign in to comment.