git.iko.soy/streamly
on master help sign in
Move the doc and re-export the core type from Array.Foreign.Mut
f197114Adithya Kumar
src/Streamly/Internal/Data/Array/Foreign/Mut.hs+16−2
compare with master
unifiedsplit
@@ -8,8 +8,22 @@
8-- Stability : experimental
8-- Stability : experimental
9-- Portability : GHC
9-- Portability : GHC
10--
10--
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+
11module Streamly.Internal.Data.Array.Foreign.Mut
25module Streamly.Internal.Data.Array.Foreign.Mut
12− (
26+ ( Array
13 -- , writeIndex
27 -- , writeIndex
14 -- , writeFrom -- start writing at the given position
28 -- , writeFrom -- start writing at the given position
15 -- , writeFromRev
29 -- , writeFromRev
@@ -21,7 +35,7 @@ module Streamly.Internal.Data.Array.Foreign.Mut
21 -- , writeChunksOfFrom
35 -- , writeChunksOfFrom
22 -- , ...
36 -- , ...
23
37
24− writeIndex
38+ , writeIndex
25 --, writeIndices
39 --, writeIndices
26 --, writeRanges
40 --, writeRanges
27
41
src/Streamly/Internal/Data/Array/Foreign/Mut/Type.hs−13
@@ -8,19 +8,6 @@
8-- Stability : experimental
8-- Stability : experimental
9-- Portability : GHC
9-- Portability : GHC
10--
10--
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
11
25module Streamly.Internal.Data.Array.Foreign.Mut.Type
12module Streamly.Internal.Data.Array.Foreign.Mut.Type
26 (
13 (