memory

memory and related abstraction stuff

Version on this page:	0.13@rev:1
LTS Haskell 20.23:	0.17.0@rev:1
Stackage Nightly 2023-05-30:	0.18.0
Latest on Hackage:	0.18.0

See all snapshots memory appears in

BSD-3-Clause licensed by Vincent Hanquez

Maintained by vincent@snarc.org

This version can be pinned in stack with:memory-0.13@sha256:7973967d0b2848f0a9bd1689dabf4f87b2801a7d06cf62035f345b6b05626b37,4008

Module documentation for 0.13

Data
- Data.ByteArray
- Data.Memory
  - Data.Memory.Encoding
  - Data.Memory.Endian
  - Data.Memory.ExtendedWords
  - Data.Memory.PtrMethods

Depends on 4 packages(full list with versions):

base, bytestring, deepseq, ghc-prim

Used by 18 packages in lts-6.35(full list with versions):

amazonka-core, asn1-types, bcrypt, cacophony, cryptohash, cryptohash-cryptoapi, cryptonite, hOpenPGP, jose, jose-jwt, jwt, securemem, tls, wai-app-static, wai-middleware-static, x509, x509-validation, yesod-auth

memory

Documentation: memory on hackage

A generic memory and related abstraction for haskell:

A polymorphic byte array abstraction and function similar to strict ByteString.
Different type of byte array abstraction.
Raw memory IO operations (memory set, memory copy, ..)
Aliasing with endianness support.

Also provides some useful helpers:

Fast Hashing : SipHash, FNV1.
Built-in base encoding : Base16, Base32, Base64.

Versioning

Development versions are an incremental number prefixed by 0. No specific meaning is associated with the versions, specially no API stability.

Production versions : TBD

Coding Style

The coding style of this project mostly follows: haskell-style

Support

Memory supports the following platform:

Windows >= 7
OSX >= 10.8
Linux

On the following architectures:

x86-64
i386

On the following haskell versions:

GHC 7.0.x
GHC 7.4.x
GHC 7.6.x
GHC 7.8.x
GHC 7.10.x

Changes

0.12

Fix compilation with mkWeak and latest GHC (Lars Kuhtz)

0.11

add support for GHC 8.0.1

0.10

make memConstEqual more constant not using boolean comparaison

0.9

memConstEqual was comparing length times the first byte instead of comparing all the bytes one to one

0.8

Add Base64 variants (Luke Taylor)
Fix compilation on Haiku (Jessica Hamilton)

0.7

Fix fixed sized scrubber written too hastily, that would zero out memory, as the index was written through byte size, whereas the primitive would consider it as WordX type index. it would helps if Ghc.Prim had better documentation.

0.6

Fix compilation on architecture where endianness is not a compile time define related to their cabal arch().

0.5

Add Base32 support (Nicolas Di Prima)
Fix build on 32 bit by simplifying scrubber, and adding Word64 type + operations compatibility

0.4

Add Ord instances for SipHash and FnvHash (Nicolas Di Prima)
Fix GHC-7.2 build by defining unsafeShiftL (Adam Bergmark)
Fix show instance of Bytes to properly display each bytes instead of just the end one
Add View type that emulate a view on a ByteArray type (Nicolas Di Prima)

0.3

fix missing modules from tests on sdist

0.2

make concat more generic as to what the output is going to be, and at the same time reduce the constraint on the input to just Access
make all byte array operation safer related to negative size. now replicate, zero, and alloc will returns an empty byte array when asking for negative size
replace ‘pack’ in Data.ByteArray.Pack by ‘fill’, as to not conflict with ‘Data.ByteArray.pack’. Also swap the length and monadic action to be more naturally used
add a deprecated ‘pack’ that alias to ‘fill’ for now
loosen constraint of Data.ByteArray.Pack.putBytes from ByteArray to ByteArrayAccess

0.1

Initial release