Data.UUID.V7

UUID type with the one from the uuid-type package.

UUIDv7 implementation.

UUIDv7 is not currently present in the uuid package, therefore I have to make a quick patch of my own.

Note that since the specification for v7 is not yet finalised, this module's implementation may change in the future according to the potential adjustments in the specification.

Data type

newtype UUID

A simple wrapper around a ByteString representing a UUIDv7.

Note that the Show instance is for debugging purposes only. To pretty-print a UUIDv7, use toString, toText or toByteString.

The UUID constructor will be hidden in favour of the Binary instance in the future.

Constructors

UUID ByteString

Instances

Show UUID

Defined in Data.UUID.V7

Methods

showsPrec :: Int -> UUID -> ShowS

show :: UUID -> String

showList :: [UUID] -> ShowS

Binary UUID

Defined in Data.UUID.V7

Methods

put :: UUID -> Put

get :: Get UUID

putList :: [UUID] -> Put

Eq UUID

Defined in Data.UUID.V7

Methods

(==) :: UUID -> UUID -> Bool

(/=) :: UUID -> UUID -> Bool

Ord UUID

Defined in Data.UUID.V7

Methods

compare :: UUID -> UUID -> Ordering

(<) :: UUID -> UUID -> Bool

(<=) :: UUID -> UUID -> Bool

(>) :: UUID -> UUID -> Bool

(>=) :: UUID -> UUID -> Bool

max :: UUID -> UUID -> UUID

min :: UUID -> UUID -> UUID

FromJSON UUID

Defined in Data.UUID.V7

Methods

parseJSON :: Value -> Parser UUID

parseJSONList :: Value -> Parser [UUID]

omittedField :: Maybe UUID

FromJSONKey UUID

Defined in Data.UUID.V7

Methods

fromJSONKey :: FromJSONKeyFunction UUID

fromJSONKeyList :: FromJSONKeyFunction [UUID]

ToJSON UUID

Defined in Data.UUID.V7

Methods

toJSON :: UUID -> Value

toEncoding :: UUID -> Encoding

toJSONList :: [UUID] -> Value

toEncodingList :: [UUID] -> Encoding

omitField :: UUID -> Bool

ToJSONKey UUID

Defined in Data.UUID.V7

Methods

toJSONKey :: ToJSONKeyFunction UUID

toJSONKeyList :: ToJSONKeyFunction [UUID]

unUUID :: UUID -> ByteString

Deprecated: Use the Binary instance instead

Deprecated. Use the Binary instance instead.

UUID generation

nil :: UUID

The nil UUIDv7.

genUUID :: IO UUID

Generate a UUIDv7.

genUUIDs :: Word16 -> IO [UUID]

Generate n UUIDv7s.

It tries its best to generate UUIDs at the same timestamp, but it may not be possible if we are asking too many UUIDs at the same time.

It is guaranteed that the first 32768 UUIDs are generated at the same timestamp.

Encoding & decoding

parseString :: String -> Maybe UUID

Parse a UUIDv7 from its String representation.

The representation is either standard or has no dashes. Does not care about the case of the letters.

parseText :: Text -> Maybe UUID

Parse a UUIDv7 from its string representation as a strict Text.

The representation is either standard or has no dashes. Does not care about the case of the letters.

parseByteString :: ByteString -> Maybe UUID

Parse a UUIDv7 from its string representation as a lazy ByteString.

The representation is either standard or has no dashes. Does not care about the case of the letters.

toString :: UUID -> String

Pretty-print a UUIDv7.

toText :: UUID -> Text

Pretty-print a UUIDv7 to strict Text.

toByteString :: UUID -> ByteString

Pretty-print a UUIDv7 to lazy ByteString.

Miscellaneous helpers

getTime :: UUID -> Word64

Get the time field (unix_ts_ms) of a UUIDv7.

getEpochMilli :: IO Word64

Get the current time in milliseconds since the Unix epoch.