Allocate an Array of the given size and run an IO action passing the array start pointer.

Allocate an array that can hold count items. The memory of the array is uninitialized.

Note that this is internal routine, the reference to this array cannot be given out until the array has been written to and frozen.

Allocate a new array aligned to the specified alignmend and using unmanaged pinned memory. The memory will not be automatically freed by GHC. This could be useful in allocate once global data structures. Use carefully as incorrect use can lead to memory leak.

allocate a new array using the provided allocator function.

Create an Array from a list. The list must be of finite size.

Since: 0.7.0

Create an Array from the first N elements of a list. The array is allocated to size N, if the list terminates before N elements then the array may hold less than N elements.

Since: 0.7.0

Use the writeN fold instead.

fromStreamDN n = D.fold (writeN n)

We could take the approach of doubling the memory allocation on each overflow. This would result in more or less the same amount of copying as in the chunking approach. However, if we have to shrink in the end then it may result in an extra copy of the entire data.

fromStreamD = StreamD.fold Array.write

Remove the free space from an Array.

O(1) Get the length of the array i.e. the number of elements in the array.

Since: 0.7.0

O(1) Get the byte length of the array.

Since: 0.7.0

Get the total capacity of an array. An array may have space reserved beyond the current used length of the array.

Pre-release

Return element at the specified index without checking the bounds.

Unsafe because it does not check the bounds of the array.

Return element at the specified index without checking the bounds.

Strict left fold of an array.

Right fold of an array.

writeN n folds a maximum of n elements from the input stream to an Array.

writeN n = Fold.take n writeNUnsafe

Since: 0.7.0

Like writeN but does not check the array bounds when writing. The fold driver must not call the step function more than n times otherwise it will corrupt the memory and crash. This function exists mainly because any conditional in the step function blocks fusion causing 10x performance slowdown.

Since: 0.7.0

writeNAligned alignment n folds a maximum of n elements from the input stream to an Array aligned to the given size.

Pre-release

writeNAlignedUnmanaged n folds a maximum of n elements from the input stream to an Array aligned to the given size and using unmanaged memory. This could be useful to allocate memory that we need to allocate only once in the lifetime of the program.

Pre-release

Fold the whole input to a single array.

Caution! Do not use this on infinite streams.

Since: 0.7.0

Like write but the array memory is aligned according to the specified alignment size. This could be useful when we have specific alignment, for example, cache aligned arrays for lookup table etc.

Caution! Do not use this on infinite streams.

Since: 0.7.0

Unfold an array into a stream.

Since: 0.7.0

Unfold an array into a stream in reverse order.

Pre-release

Resumable unfold of an array.

Use the "read" unfold instead.

flattenArrays = unfoldMany read

We can try this if there are any fusion issues in the unfold.

Use the "readRev" unfold instead.

flattenArrays = unfoldMany readRev

We can try this if there are any fusion issues in the unfold.

Use the read unfold instead.

toStreamD = D.unfold read

We can try this if the unfold has any performance issues.

Use the readRev unfold instead.

toStreamDRev = D.unfold readRev

We can try this if the unfold has any perf issues.

Convert an Array into a list.

Since: 0.7.0

Splice an array into a pre-reserved mutable array. The user must ensure that there is enough space in the mutable array, otherwise the splicing fails.

Splice a new array into a preallocated mutable array, doubling the space if there is no space in the target array.

Copy two arrays into a newly allocated array.

Drops the separator byte

Create two slices of an array without copying the original array. The specified index i is the first index of the second slice.

Since: 0.7.0

arraysOf n stream groups the input stream into a stream of arrays of size n.

arraysOf n = StreamD.foldMany (Array.writeN n)

Pre-release

Buffer the stream into arrays in memory.

Buffer a stream into a stream of arrays.

writeChunks = Fold.many Fold.toStream (Array.writeN n)

See bufferChunks.

Unimplemented

Default maximum buffer size in bytes, for reading from and writing to IO devices, the value is 32KB minus GHC allocation overhead, which is a few bytes, so that the actual allocation is 32KB.