@@ -8,8 +8,22 @@
88-- Stability : experimental
99-- Portability : GHC
1010--
11+-- Unboxed pinned mutable array type for 'Storable' types with an option to use
12+-- foreign (non-GHC) memory allocators. Fulfils the following goals:
13+--
14+-- * Random access (array)
15+-- * Efficient storage (unboxed)
16+-- * Performance (unboxed access)
17+-- * Performance - in-place operations (mutable)
18+-- * Performance - GC (pinned, mutable)
19+-- * interfacing with OS (pinned)
20+-- * Fragmentation control (foreign allocators)
21+--
22+-- Stream and Fold APIs allow easy, efficient and convenient operations on
23+-- arrays.
24+
1125module Streamly.Internal.Data.Array.Foreign.Mut
12− (
26+ ( Array
1327 -- , writeIndex
1428 -- , writeFrom -- start writing at the given position
1529 -- , writeFromRev
@@ -21,7 +35,7 @@ module Streamly.Internal.Data.Array.Foreign.Mut
2135 -- , writeChunksOfFrom
2236 -- , ...
2337
24− writeIndex
38+ , writeIndex
2539 --, writeIndices
2640 --, writeRanges
2741