@@ -5,10 +5,16 @@
5-- | [`Data.Binary.Put`](https://hackage.haskell.org/package/binary/docs/Data-Binary-Put.html)
5-- | [`Data.Binary.Put`](https://hackage.haskell.org/package/binary/docs/Data-Binary-Put.html)
6-- | module.
6-- | module.
8−-- | This library defines no typeclasses.
8+-- | This library defines no typeclasses. Typeclass-based
9+-- | serialization/deserialization generally assumes that we are round-tripping
10+-- | some data structures out to storage and then back into our program.
11+-- | This library is designed for the case that we are serializing some data
12+-- | to be sent to another program which expects a certain serialization format
13+-- | that we don't control.
10-- | ## Deserialization
15-- | ## Deserialization
17+-- | This module is only for writing `ArrayBuffer`s, not reading them.
13-- | [__purescript-parsing-dataview__](https://pursuit.purescript.org/packages/purescript-parsing-dataview/)
19-- | [__purescript-parsing-dataview__](https://pursuit.purescript.org/packages/purescript-parsing-dataview/)
14-- | for a way to deserialize from `ArrayBuffer` back to Purescript data.
20-- | for a way to deserialize from `ArrayBuffer` back to Purescript data.
@@ -440,11 +446,6 @@ putFloat64le = putArrayBuffer <=< encodeFloat64le
440-- | We hope that this implementation is fairly fast, but we
446-- | We hope that this implementation is fairly fast, but we
441-- | haven't chosen this implementation because it's fast, we've chosen
447-- | haven't chosen this implementation because it's fast, we've chosen
442-- | this implementation because it's simple.
448-- | this implementation because it's simple.
443−-- | The only currently existing Purescript libary which does ArrayBuffer
444−-- | serialization is
445−-- | https://pursuit.purescript.org/packages/purescript-arraybuffer-class
446−-- | , and that library is heavily typeclass-based and designed
447−-- | for compatibility with the Haskell cereal library.
448-- | If someone wants to create a fast Purescript ArrayBuffer serialization
449-- | If someone wants to create a fast Purescript ArrayBuffer serialization
449-- | library, then they can benchmark against this one to prove that the new
450-- | library, then they can benchmark against this one to prove that the new
450-- | one is fast.
451-- | one is fast.
@@ -461,3 +462,7 @@ putFloat64le = putArrayBuffer <=< encodeFloat64le
462-- | We've tried to design the API for this library with minimal assumptions,
463-- | We've tried to design the API for this library with minimal assumptions,
463-- | so that if we want to change the Builder implementation later then we can.
464-- | so that if we want to change the Builder implementation later then we can.
467+-- | https://pursuit.purescript.org/packages/purescript-node-buffer
468+-- | https://pursuit.purescript.org/packages/purescript-arraybuffer-class