Data.Parameterized.Nonce.Unsafe

This module provides a simple generator of new indexes in the ST monad. It is predictable and not intended for cryptographic purposes.

NOTE: the TestEquality and OrdF instances for the Nonce type simply compare the generated nonce values and then assert to the compiler (via unsafeCoerce) that the types ascribed to the nonces are equal if their values are equal. This is only OK because of the discipline by which nonces should be used: they should only be generated from a NonceGenerator (i.e., should not be built directly), and nonces from different generators must never be compared! Arranging to compare Nonces from different origins would allow users to build unsafeCoerce via the testEquality function.

A somewhat safer API would be to brand the generated Nonces with the state type variable of the NonceGenerator whence they came, and to only provide NonceGenerators via a Rank-2 continuation-passing API, similar to runST. This would (via a meta-argument involving parametricity) help to prevent nonces of different origin from being compared. However, this would force us to push the ST type brand into a significant number of other structures and APIs.

Another alternative would be to use unsafePerformIO magic to make a global nonce generator, and make that the only way to generate nonces. It is not clear that this is actually an improvement from a type safety point of view, but an argument could be made.

For now, be careful using Nonces, and ensure that you do not mix Nonces from different NonceGenerators.

Documentation

data NonceGenerator s

A simple type that for getting fresh indices in the ST monad. The type parameter s is used for the ST monad parameter.

newNonceGenerator :: ST s (NonceGenerator s)

Create a new counter.

freshNonce :: NonceGenerator s -> ST s (Nonce tp)

Get a fresh index and increment the counter.

atLimit :: NonceGenerator s -> ST s Bool

Return true if counter has reached the limit, and can't be incremented without risk of error.

data Nonce (tp :: k)

An index generated by the counter.

Instances

TestEquality (Nonce :: k -> *)

Defined in Data.Parameterized.Nonce.Unsafe

Methods

testEquality :: Nonce a -> Nonce b -> Maybe (a :~: b)

HashableF (Nonce :: k -> *)

Defined in Data.Parameterized.Nonce.Unsafe

Methods

hashWithSaltF :: Int -> Nonce tp -> Int

hashF :: Nonce tp -> Int

ShowF (Nonce :: k -> *)

Defined in Data.Parameterized.Nonce.Unsafe

Methods

withShow :: p Nonce -> q tp -> (Show (Nonce tp) -> a) -> a

showF :: Nonce tp -> String

showsPrecF :: Int -> Nonce tp -> String -> String

OrdF (Nonce :: k -> *)

Defined in Data.Parameterized.Nonce.Unsafe

Methods

compareF :: Nonce x -> Nonce y -> OrderingF x y

leqF :: Nonce x -> Nonce y -> Bool

ltF :: Nonce x -> Nonce y -> Bool

geqF :: Nonce x -> Nonce y -> Bool

gtF :: Nonce x -> Nonce y -> Bool

Eq (Nonce tp)

Defined in Data.Parameterized.Nonce.Unsafe

Methods

(==) :: Nonce tp -> Nonce tp -> Bool

(/=) :: Nonce tp -> Nonce tp -> Bool

Ord (Nonce tp)

Defined in Data.Parameterized.Nonce.Unsafe

Methods

compare :: Nonce tp -> Nonce tp -> Ordering

(<) :: Nonce tp -> Nonce tp -> Bool

(<=) :: Nonce tp -> Nonce tp -> Bool

(>) :: Nonce tp -> Nonce tp -> Bool

(>=) :: Nonce tp -> Nonce tp -> Bool

max :: Nonce tp -> Nonce tp -> Nonce tp

min :: Nonce tp -> Nonce tp -> Nonce tp

Show (Nonce tp)

Defined in Data.Parameterized.Nonce.Unsafe

Methods

showsPrec :: Int -> Nonce tp -> ShowS

show :: Nonce tp -> String

showList :: [Nonce tp] -> ShowS

Hashable (Nonce tp)

Defined in Data.Parameterized.Nonce.Unsafe

Methods

hashWithSalt :: Int -> Nonce tp -> Int

hash :: Nonce tp -> Int

indexValue :: Nonce tp -> Word64