pvar: Mutable variable with primitive values

Mutable variable PVar that is backed by a single value MutableByteArray

[Skip to Readme]

Modules

For package maintainers and hackage trustees

Candidates

Versions [RSS]	0.1.0.0, 0.1.1.0, 0.2.0.0, 1.0.0.0
Change log	CHANGELOG.md
Dependencies	base (>=4.8 && <6), deepseq, primitive (>=0.5.4.0) [details]
Tested with	ghc ==7.10.2, ghc ==7.10.3, ghc ==8.0.1, ghc ==8.0.2, ghc ==8.2.2, ghc ==8.4.3, ghc ==8.4.4, ghc ==8.6.3, ghc ==8.6.4, ghc ==8.6.5, ghc ==8.8.2, ghc ==8.8.3
License	BSD-3-Clause
Copyright	2020 Alexey Kuleshevich
Author	Alexey Kuleshevich
Maintainer	alexey@kuleshevi.ch
Category	Data
Home page	https://github.com/lehins/pvar#readme
Bug tracker	https://github.com/lehins/pvar/issues
Source repo	head: git clone https://github.com/lehins/pvar
Uploaded	by lehins at 2020-04-02T02:59:39Z
Distributions	LTSHaskell:1.0.0.0, NixOS:1.0.0.0, Stackage:1.0.0.0
Reverse Dependencies	2 direct, 19 indirect [details]
Downloads	4026 total (4 in the last 30 days)
Rating	2.0 (votes: 1) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs available [build log] Last success reported on 2020-04-02 [all 1 reports]

Interface for a mutable variable PVar that can hold values that have Prim instance.

Language	Travis	Azure	Coveralls

Package	Hackage	Nightly	LTS
`pvar`

Main features include:

Performance. There is practically no overhead when compared to operating on pure values, although there is a higher memory overhead, since PVar is backed by a MutableByteArray#
Atomic operations for PVars with Int values. This includes a unique function that is not available in ghc-prim out of the box:

atomicModifyIntPVar :: PrimMonad m => PVar m Int -> (Int -> (Int, a)) -> m a

Works in PrimMonad, therefore it is usable with ST, IO and various transformer monads.
Easy access to PVar contents with Storable
isByteArrayPinned, isMutableByteArrayPinned function that work on ghc-7.10 and ghc-8.0 as well as all the newer ones.