ArrayRef-0.1.2: Unboxed references, dynamic arrays and more Contents Index

Data.SyntaxSugar Portability Hugs/GHC Stability experimental Maintainer Bulat Ziganshin <Bulat.Ziganshin@gmail.com>

Description

Universal interface for reading and writing mutable data (references, array and hash elements) Syntax sugar (=:, +=, val...) based on this interface

Synopsis

class Monad m => Mutable m r a | r -> a where readVar :: r -> m a writeVar :: r -> a -> m () modifyVar :: Mutable m r b => r -> (b -> b) -> m () modifyVarM :: Mutable m r a => r -> (a -> m a) -> m () hashUpdate :: HashTable key val -> key -> val -> IO Bool ref :: Ref m r => a -> m (r a) uref :: (Unboxed a, URef m r) => a -> m (r a) val :: Mutable m r a => r -> m a (=:) :: Mutable m r a => r -> a -> m () (+=) :: (Mutable m r b, Num b) => r -> b -> m () (-=) :: (Mutable m r b, Num b) => r -> b -> m () (.=) :: Mutable m r b => r -> (b -> b) -> m () (.<-) :: Mutable m r a => r -> (a -> m a) -> m ()

Documentation

class Monad m => Mutable m r a | r -> a where

Methods readVar :: r -> m a Read the value of an Mutable writeVar :: r -> a -> m () Write new value into an Mutable Instances Mutable IO (IORef a) a Mutable IO (IORef a) a Unboxed a => Mutable IO (IOURef a) a Unboxed a => Mutable IO (IOURef a) a Mutable IO ((,) (HashTable key e) key) e (Storable e, Ix i) => Mutable IO ((,) (StorableArray i e) i) e (Unboxed e, Ix i) => Mutable IO ((,) (IOUArray i e) i) e Ix i => Mutable IO ((,) (IOArray i e) i) e (Unboxed e, Ix i) => Mutable (ST s) ((,) (STUArray s i e) i) e Ix i => Mutable (ST s) ((,) (STArray s i e) i) e Unboxed a => Mutable (ST s) (STURef s a) a Unboxed a => Mutable (ST s) (STURef s a) a Mutable (ST s) (STRef s a) a Mutable (ST s) (STRef s a) a

modifyVar :: Mutable m r b => r -> (b -> b) -> m ()

Modify the contents of an Mutable by applying pure function to it

modifyVarM :: Mutable m r a => r -> (a -> m a) -> m ()

Modify the contents of an Mutable by applying monadic computation to it

hashUpdate :: HashTable key val -> key -> val -> IO Bool

ref :: Ref m r => a -> m (r a)

uref :: (Unboxed a, URef m r) => a -> m (r a)

val :: Mutable m r a => r -> m a

(=:) :: Mutable m r a => r -> a -> m ()

(+=) :: (Mutable m r b, Num b) => r -> b -> m ()

(-=) :: (Mutable m r b, Num b) => r -> b -> m ()

(.=) :: Mutable m r b => r -> (b -> b) -> m ()

(.<-) :: Mutable m r a => r -> (a -> m a) -> m ()

Produced by Haddock version 2.1.0