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


-- | This library is useful for creating, comparing, parsing and printing
--   Universally Unique Identifiers.
--   
--   See <a>http://en.wikipedia.org/wiki/UUID</a> for the general idea.
@package uuid
@version 1.3.16


-- | This library is useful for comparing, parsing and printing Universally
--   Unique Identifiers. See <a>http://en.wikipedia.org/wiki/UUID</a> for
--   the general idea. See <a>http://tools.ietf.org/html/rfc4122</a> for
--   the specification.
--   
--   <ul>
--   <li>Use <a>nextRandom</a> to generate secure random UUIDs, and your
--   favorite instance of <a>Random</a> for faster but insecure generation
--   of UUIDs.</li>
--   <li>We have an implementation of generating a UUID from the hardware
--   MAC address and current system time in <a>Data.UUID.V1</a>.</li>
--   <li>For name-based generation of UUIDs using SHA-1 hashing see
--   <a>Data.UUID.V5</a>.</li>
--   </ul>
module Data.UUID
data UUID
toString :: UUID -> String
fromString :: String -> Maybe UUID
toText :: UUID -> Text
fromText :: Text -> Maybe UUID
toASCIIBytes :: UUID -> ByteString
fromASCIIBytes :: ByteString -> Maybe UUID
toLazyASCIIBytes :: UUID -> ByteString
fromLazyASCIIBytes :: ByteString -> Maybe UUID
toByteString :: UUID -> ByteString
fromByteString :: ByteString -> Maybe UUID
toWords :: UUID -> (Word32, Word32, Word32, Word32)
fromWords :: Word32 -> Word32 -> Word32 -> Word32 -> UUID
toWords64 :: UUID -> (Word64, Word64)
fromWords64 :: Word64 -> Word64 -> UUID
null :: UUID -> Bool
nil :: UUID


-- | RFC 4122 Version 1 UUID state machine.
--   
--   The generated UUID is based on the hardware MAC address and the system
--   clock.
--   
--   If we cannot lookup the MAC address we seed the generator with a
--   pseudo-random number.
module Data.UUID.V1

-- | Returns a new UUID derived from the local hardware MAC address and the
--   current system time. Is generated according to the Version 1 UUID
--   specified in RFC 4122.
--   
--   Returns <a>Nothing</a> if you request UUIDs too quickly.
nextUUID :: IO (Maybe UUID)
instance Data.UUID.Types.Internal.Builder.ByteSource Data.UUID.V1.MACSource
instance GHC.Internal.Show.Show Data.UUID.V1.State


-- | NOTE: This module uses MD5 hashing. Unless you know you need to use
--   this module, you should probably be using <a>Data.UUID.V5</a>, which
--   offers the same sort of functionality as this module except
--   implemented with SHA-1 hashing.
--   
--   This module implements Version 3 UUIDs as specified in RFC 4122.
--   
--   These UUIDs identify an object within a namespace, and are
--   deterministic.
--   
--   The namespace is identified by a UUID. Several sample namespaces are
--   enclosed.
module Data.UUID.V3

-- | Generate a <a>UUID</a> within the specified namespace out of the given
--   object.
--   
--   Uses an MD5 hash. The UUID is built from first 128 bits of the hash of
--   the namespace UUID and the name (as a series of Word8).
generateNamed :: UUID -> [Word8] -> UUID

-- | The namespace for DNS addresses
namespaceDNS :: UUID

-- | The namespace for URLs
namespaceURL :: UUID

-- | The namespace for ISO OIDs
namespaceOID :: UUID

-- | The namespace for X.500 DNs
namespaceX500 :: UUID


-- | This module implements Version 4 UUIDs as specified in RFC 4122.
--   
--   These UUIDs are generated from a pseudo-random generator. We use the
--   <a>getEntropy</a> method from the <a>entropy</a> package, which should
--   provide cryptographically secure random data.
module Data.UUID.V4

-- | Generate a crytographically secure, random UUID.
nextRandom :: IO UUID


-- | This module implements Version 5 UUIDs as specified in RFC 4122.
--   
--   These UUIDs identify an object within a namespace, and are
--   deterministic.
--   
--   The namespace is identified by a UUID. Several sample namespaces are
--   enclosed.
module Data.UUID.V5

-- | Generate a <a>UUID</a> within the specified namespace out of the given
--   object.
--   
--   Uses a SHA1 hash. The UUID is built from first 128 bits of the hash of
--   the namespace UUID and the name (as a series of Word8).
generateNamed :: UUID -> [Word8] -> UUID

-- | The namespace for DNS addresses
namespaceDNS :: UUID

-- | The namespace for URLs
namespaceURL :: UUID

-- | The namespace for ISO OIDs
namespaceOID :: UUID

-- | The namespace for X.500 DNs
namespaceX500 :: UUID

module Data.UUID.Util
data UnpackedUUID
UnpackedUUID :: Word32 -> Word16 -> Word16 -> Word8 -> Word8 -> Word8 -> Word8 -> Word8 -> Word8 -> Word8 -> Word8 -> UnpackedUUID
[time_low] :: UnpackedUUID -> Word32
[time_mid] :: UnpackedUUID -> Word16
[time_hi_and_version] :: UnpackedUUID -> Word16
[clock_seq_hi_res] :: UnpackedUUID -> Word8
[clock_seq_low] :: UnpackedUUID -> Word8
[node_0] :: UnpackedUUID -> Word8
[node_1] :: UnpackedUUID -> Word8
[node_2] :: UnpackedUUID -> Word8
[node_3] :: UnpackedUUID -> Word8
[node_4] :: UnpackedUUID -> Word8
[node_5] :: UnpackedUUID -> Word8
unpack :: UUID -> UnpackedUUID
pack :: UnpackedUUID -> UUID
version :: UUID -> Int
extractMac :: UUID -> Maybe MAC
extractTime :: UUID -> Maybe Int64
setTime :: (Integral a, Bits a) => UUID -> a -> Maybe UUID
