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


-- | A monad for using CryptoRandomGen
--   
--   A monad for using CryptoRandomGen
@package monadcryptorandom
@version 0.2


-- | Much like the <a>MonadRandom</a> package
--   (<a>Control.Monad.Random</a>), this module provides plumbing for the
--   CryptoRandomGen generators.
module Control.Monad.Crypto.Random

-- | <tt>CRandom a</tt> is much like the <tt>Random</tt> class from the
--   <a>System.Random</a> module in the <a>random</a> package. The main
--   difference is CRandom builds on <a>crypto-api</a>'s
--   <a>CryptoRandomGen</a>, so it allows explicit failure.
--   
--   <tt>crandomR (low,high) g</tt> as typically instantiated will generate
--   a value between [low, high] inclusively, swapping the pair if high
--   &lt; low.
--   
--   Provided instances for <tt>crandom g</tt> generates randoms between
--   the bounds and between +/- 2^256 for Integer.
--   
--   The <a>crandomR</a> function has degraded (theoretically unbounded,
--   probabilistically decent) performance the closer your range size (high
--   - low) is to 2^n (from the top).
class CRandom a
crandom :: (CRandom a, CryptoRandomGen g) => g -> Either GenError (a, g)
crandomR :: (CRandom a, CryptoRandomGen g) => (a, a) -> g -> Either GenError (a, g)
crandoms :: (CRandom a, CryptoRandomGen g) => g -> [a]
crandomRs :: (CRandom a, CryptoRandomGen g) => (a, a) -> g -> [a]

-- | <tt>MonadCryptoRandom m</tt> represents a monad that can produce
--   random values (or fail with a <a>GenError</a>). It is suggestd you use
--   the <a>CRandT</a> transformer in your monad stack.
class MonadError GenError m => MonadCryptoRandom m
getCRandom :: (MonadCryptoRandom m, CRandom a) => m a
getCRandomR :: (MonadCryptoRandom m, CRandom a) => (a, a) -> m a
getBytes :: MonadCryptoRandom m => Int -> m ByteString
getBytesWithEntropy :: MonadCryptoRandom m => Int -> ByteString -> m ByteString
doReseed :: MonadCryptoRandom m => ByteString -> m ()

-- | CRandT is the transformer suggested for MonadCryptoRandom.
data CRandT g m a

-- | Simple users of generators can use CRand for quick and easy generation
--   of randoms. See below for a simple use of <a>newGenIO</a> (from
--   <a>crypto-api</a>), <a>getCRandom</a>, <a>getBytes</a>, and
--   <tt>runCRandom</tt>.
--   
--   <pre>
--   getRandPair = do
--      int &lt;- getCRandom
--      bytes &lt;- getBytes 100
--      return (int, bytes)
--   
--   func = do
--      g &lt;- newGenIO
--      case runCRand getRandPair g of
--          Right ((int,bytes), g') -&gt; useRandomVals (int,bytes)
--          Left x -&gt; handleGenError x
--   </pre>
type CRand g = CRandT g Identity
runCRandT :: CRandT g m a -> g -> m (Either GenError (a, g))
evalCRandT :: Monad m => CRandT g m a -> g -> m (Either GenError a)
runCRand :: CRand g a -> g -> Either GenError (a, g)
evalCRand :: CRand g a -> g -> Either GenError a
instance Monad m => MonadError GenError (CRandT g m)
instance Monad m => Monad (CRandT g m)
instance Error GenError
instance (Monad m, CryptoRandomGen g) => MonadCryptoRandom (CRandT g m)
instance MonadTrans (CRandT g)
instance CRandom Int64
instance CRandom Int32
instance CRandom Int16
instance CRandom Int8
instance CRandom Word64
instance CRandom Word32
instance CRandom Word16
instance CRandom Word8
instance CRandom Int
instance CRandom Integer