BSD-3-Clause licensed by Roman Leshchinskiy
Maintained by [email protected]
This version can be pinned in stack with:primitive-,3241

This package provides various primitive memory-related operations.


Changes in version

  • Add resizeSmallMutableArray that wraps resizeSmallMutableArray# from GHC.Exts.

  • New module Data.Primitive.PrimVar. This is essentially PrimArray with element length 1. For types with Prim instances, this is a drop-in replacement for MutVar with fewer indirections.

  • PrimArray’s type argument has been given a nominal role instead of a phantom role. This is a breaking change.

  • Add readCharArray, writeCharArray, indexCharArray for operating on 8-bit characters in a byte array.

  • When building with base-4.17 and newer, re-export the ByteArray and MutableByteArray types from base instead of defining them in this library. This does not change the user-facing interface of Data.Primitive.ByteArray.

  • Add keepAlive that wraps keepAlive# for GHC 9.2 and newer. It falls back to using touch for older GHCs.

Changes in version

  • Add Lift instances (#332)

  • Expose copyPtrToMutablePrimArray

  • Improve definitions for stimes (#326)

  • Support GHC 9.4. Note: GHC 9.4 is not released at the time of primitive-’s release, so this support might be reverted by a hackage metadata revision if things change.

  • Drop support for GHC 7.10

Changes in version

  • Correct implementations of *> for Array and SmallArray.

  • Drop support for GHC < 7.10

  • Export runByteArray and runPrimArray.

  • Export createArray and createSmallArray.

  • Export emptyByteArray, emptyPrimArray, emptyArray and emptySmallArray.

Changes in version

  • Add thawByteArray and thawPrimArray.

  • Changed the Show instance of ByteArray, so that all 8-bit words are rendered as two digits. For example, display 0x0D instead of 0xD.

Changes in version

  • Introduce convenience class MonadPrim and MonadPrimBase.

  • Add PrimMonad and PrimBase instances for Lazy.ST (GHC >= 8.2). thanks to Avi Dessauer (@Avi-D-coder) for this first contribution

  • Add freezeByteArray and freezePrimArray.

  • Add compareByteArrays.

  • Add shrinkMutableByteArray.

  • Add Eq instances for MutableByteArray and MutablePrimArray. by Andrew Martin

  • Add functions for manipulating pinned Prim Arrays by Andrew Martin

  • Add copyPtrToMutableByteArray.

  • Add NFData instances for ByteArray, MutableByteArray, PrimArray and MutablePrimArray. by Callan McGill

  • Add shrinkSmallMutableArray.

  • Add clonePrimArray and cloneMutablePrimArray.

  • Add cloneMutableByteArray and cloneByteArray.

  • Add Prim instances for WordPtr and IntPtr.

  • Add NFData instances for Array and SmallArray. by Callan McGill

  • Add copyByteArrayToPtr and copyMutableByteArrayToPtr.

  • Export arrayFromList and arrayFromListN.

Changes in version

  • Allow building with GHC 8.12. Thanks Ryan GL Scott for this and every compat patch over time.

Changes in version

  • Remove Addr data type, lifted code should use Ptr a now

  • Define MonadFail instances for Array and SmallArray.

  • Define unsafeInterleave.

  • Add a Prim instance for StablePtr

  • Remove UnliftedArray and related type classes

  • Add a lot more tests for PrimArray.

  • Added PrimMonad instance for CPS Writer and RWS monads from Transformers

  • Remove useless accidental laziness in atomicModifyMutVar, making it match atomicModifyIORef. The semantics should be the same.

  • lots of little documentation twiddles.

Changes in version

  • Add instances for the following newtypes from base: Const, Identity, Down, Dual, Sum, Product, First, Last, Min, Max

  • Add base-orphans dependency to test suite to accomodate older versions of GHC not having instances of Show and Eq for some of the above newtypes.

Changes in version

  • Introduce Data.Primitive.PrimArray, which offers types and function for dealing with a ByteArray tagged with a phantom type variable for tracking the element type.

  • Implement isByteArrayPinned and isMutableByteArrayPinned.

  • Add Eq1, Ord1, Show1, and Read1 instances for Array and SmallArray.

  • Improve the test suite. This includes having property tests for typeclasses from base such as Eq, Ord, Functor, Applicative, Monad, IsList, Monoid, Foldable, and Traversable.

  • Fix the broken IsList instance for ByteArray. The old definition would allocate a byte array of the correct size and then leave the memory unitialized instead of writing the list elements to it.

  • Fix the broken Functor instance for Array. The old definition would allocate an array of the correct size with thunks for erroring installed at every index. It failed to replace these thunks with the result of the function applied to the elements of the argument array.

  • Fix the broken Applicative instances of Array and SmallArray. The old implementation of <*> for Array failed to initialize some elements but correctly initialized others in the resulting Array. It is unclear what the old behavior of <*> was for SmallArray, but it was incorrect.

  • Fix the broken Monad instances for Array and SmallArray.

  • Fix the implementation of foldl1 in the Foldable instances for Array and SmallArray. In both cases, the old implementation simply returned the first element of the array and made no use of the other elements in the array.

  • Fix the implementation of mconcat in the Monoid instance for SmallArray.

  • Implement Data.Primitive.Ptr, implementations of Ptr functions that require a Prim constraint instead of a Storable constraint.

  • Add PrimUnlifted instances for TVar and MVar.

  • Use compareByteArrays# for the Eq and Ord instances of ByteArray when building with GHC 8.4 and newer.

  • Add Prim instances for lots of types in Foreign.C.Types and System.Posix.Types.

  • Reexport Data.Primitive.SmallArray and Data.Primitive.UnliftedArray from Data.Primitive.

  • Add fold functions and map function to Data.Primitive.UnliftedArray. Add typeclass instances for IsList, Ord, and Show.

  • Add defaultSetByteArray# and defaultSetOffAddr# to Data.Primitive.Types.

  • Add Data.Primitive.MVar, a replacement for Control.Concurrent.MVar that can run in any PrimMonad instead of just IO. It is not a full replacement. Notably, it’s missing masking functions and support for adding finalizers.

Changes in version

  • Add PrimMonad instances for ContT, AccumT, and SelectT from transformers

  • Add Eq, Ord, Show, and IsList instances for ByteArray

  • Add Semigroup instances for Array and SmallArray. This allows primitive to build on GHC 8.4 and later.

Changes in version

  • Drop support for GHCs before 7.4

  • SmallArray support

  • ArrayArray# based support for more efficient arrays of unlifted pointer types

  • Make Array and the like instances of various classes for convenient use

  • Add Prim instances for Ptr and FunPtr

  • Add ioToPrim, stToPrim and unsafe counterparts for situations that would otherwise require type ascriptions on primToPrim

  • Add evalPrim

  • Add PrimBase instance for IdentityT

Changes in version

  • Use more appropriate types in internal memset functions, which prevents overflows/segfaults on 64-bit systems.

  • Fixed a warning on GHC 7.10

  • Worked around a -dcore-lint bug in GHC 7.6/7.7

Changes in version 0.6

  • Split PrimMonad into two classes to allow automatic lifting of primitive operations into monad transformers. The internal operation has moved to the PrimBase class.

  • Fixed the test suite on older GHCs

Changes in version

  • Changed primitive_ to work around an oddity with GHC’s code generation on certain versions that led to side effects not happening when used in conjunction with certain very unsafe IO performers.

  • Allow primitive to build on GHC 7.9

Changes in version

  • Implement cloneArray and cloneMutableArray primitives (with fall-back implementations for GHCs prior to version 7.2.1)

Changes in version

  • Add strict variants of MutVar modification functions atomicModifyMutVar' and modifyMutVar'

  • Fix compilation on Solaris 10 with GNU C 3.4.3

Changes in version

  • Add support for GHC 7.7’s new primitive Bool representation

Changes in version

  • Disable array copying primitives for GHC 7.6.* and earlier

Changes in version 0.5

  • New in Data.Primitive.MutVar: atomicModifyMutVar

  • Efficient block fill operations: setByteArray, setAddr

Changes in version 0.4.1

  • New module Data.Primitive.MutVar

Changes in version

  • Critical bug fix in fillByteArray

Changes in version 0.4

  • Support for GHC 7.2 array copying primitives

  • New in Data.Primitive.ByteArray: copyByteArray, copyMutableByteArray, moveByteArray, fillByteArray

  • Deprecated in Data.Primitive.ByteArray: memcpyByteArray, memcpyByteArray', memmoveByteArray, memsetByteArray

  • New in Data.Primitive.Array: copyArray, copyMutableByteArray

  • New in Data.Primitive.Addr: copyAddr, moveAddr

  • Deprecated in Data.Primitive.Addr: memcpyAddr