-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Like IORef but for Fay.
--   
--   Like IORef but for Fay.
@package fay-ref
@version 0.1.0.0

module FayRef

-- | A mutable variable in the <a>Fay</a> monad.
data FayRef a

-- | Build a new <a>FayRef</a>.
newFayRef :: a -> Fay (FayRef a)

-- | Write a new value into a <a>FayRef</a>.
readFayRef :: FayRef a -> Fay a

-- | Write a new value into a <a>FayRef</a>.
writeFayRef :: FayRef a -> a -> Fay ()

-- | Mutate the contents of a <a>FayRef</a>.
--   
--   Be warned that <a>modifyFayRef</a> does not apply the function
--   strictly. This means if the program calls <a>modifyFayRef</a> many
--   times, but seldomly uses the value, thunks will pile up in memory
--   resulting in a space leak.
modifyFayRef :: FayRef a -> (a -> a) -> Fay ()

-- | Strict version of <a>modifyFayRef</a>
modifyFayRef' :: FayRef a -> (a -> a) -> Fay ()