Data.UUID.Types · uuid-types-1.0.6

The UUID Type

1 declaration

datadata UUID

#

Type representing Universally Unique Identifiers (UUID) as specified in RFC 4122.

Instances12Eq, Data, Ord, Read, Show, Storable, …

Eq UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal
Data UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal
Ord UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal
Read UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal
Show UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal
Pretty prints a UUID (without quotation marks). See also toString.
Example1 expression
```
>>> show nil"00000000-0000-0000-0000-000000000000"
```
Storable UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal
This Storable instance uses the memory layout as described in RFC 4122, but in contrast to the Binary instance, the fields are stored in host byte order.
NFData UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal
Random UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal
This Random instance produces insecure version 4 UUIDs as specified in RFC 4122.
Uniform UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal
Binary UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal
This Binary instance is compatible with RFC 4122, storing the fields in network order as 16 bytes.
Hashable UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal
Lift UUIDDefined in uuid-types-1.0.6 · Data.UUID.Types.Internal

Nil UUID

2 declarations

valuenil :: UUID

#

The nil UUID, as defined in RFC 4122. It is a UUID of all zeros. null u iff u == nil.

valuenull :: UUID -> Bool

#

Returns true if the passed-in UUID is the nil UUID.

Textual Representation

8 declarations

valuetoString :: UUID -> String

#

Convert a UUID into a hypenated string using lower-case letters. Example:

Example1 expression

>>> toString <$> fromString "550e8400-e29b-41d4-a716-446655440000"Just "550e8400-e29b-41d4-a716-446655440000"

valuefromString :: String -> Maybe UUID

#

If the passed in String can be parsed as a UUID, it will be. The hyphens may not be omitted. Example:

Example1 expression

>>> fromString "c2cc10e1-57d6-4b6f-9899-38d972112d8c"Just c2cc10e1-57d6-4b6f-9899-38d972112d8c

Hex digits may be upper or lower-case.

valuetoText :: UUID -> Text

#

Convert a UUID into a hyphentated string using lower-case letters.

valuefromText :: Text -> Maybe UUID

#

If the passed in Text can be parsed as an ASCII representation of a UUID, it will be. The hyphens may not be omitted.

valuetoASCIIBytes :: UUID -> ByteString

#

Convert a UUID into a hyphentated string using lower-case letters, packed as ASCII bytes into ByteString.

This should be equivalent to toString with pack.

valuefromASCIIBytes :: ByteString -> Maybe UUID

#

If the passed in ByteString can be parsed as an ASCII representation of a UUID, it will be. The hyphens may not be omitted.

This should be equivalent to fromString with unpack.

valuetoLazyASCIIBytes :: UUID -> ByteString

#

Similar to toASCIIBytes except we produce a lazy ByteString.

valuefromLazyASCIIBytes :: ByteString -> Maybe UUID

#

Similar to fromASCIIBytes except parses from a lazy ByteString.

Binary Representation

2 declarations

valuetoByteString :: UUID -> ByteString

#

Encode a UUID into a ByteString in network order.

This uses the same encoding as the Binary instance.

valuefromByteString :: ByteString -> Maybe UUID

#

Extract a UUID from a ByteString in network byte order. The argument must be 16 bytes long, otherwise Nothing is returned.

Integer Representation

4 declarations

valuetoWords :: UUID -> (Word32, Word32, Word32, Word32)

#

Convert a UUID into a sequence of Word32 values. Useful for when you need to serialize a UUID and neither Storable nor Binary are appropriate.

Example1 expression

>>> toWords <$> fromString "550e8400-e29b-41d4-a716-446655440000"Just (1427014656,3801825748,2803254374,1430519808)