Data.TypeID.V7

An implementation of the TypeID specification: https://github.com/jetpack-io/typeid.

Data types

type TypeID = TypeID' 'V7

A type alias for the default TypeID implementation with UUIDv7.

type TypeIDV7 = TypeID

A type alias for TypeID.

getPrefix :: IDType a => a -> Text

Get the prefix of the identifier.

getUUID :: IDType a => a -> UUID

Get the UUID suffix of the identifier.

getTime :: IDType a => a -> Word64

Get the timestamp of the identifier. Returns 0 if the identifier is not timestamp-based.

TypeID generation (TypeID-specific)

genTypeID :: MonadIO m => Text -> m TypeID

Generate a new TypeID from a prefix.

It throws a TypeIDError if the prefix does not match the specification, namely if it's longer than 63 characters or if it contains characters other than lowercase latin letters.

genTypeID' :: MonadIO m => Text -> m TypeID

Generate a new TypeID from a prefix based on stateless UUIDv7.

See the documentation of genUUID' for more information.

genTypeIDs :: MonadIO m => Text -> Word16 -> m [TypeID]

Generate a list of TypeIDs from a prefix.

It tries its best to generate TypeIDs 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 TypeIDs are generated at the same timestamp.

decorateTypeID :: Text -> UUID -> Either TypeIDError TypeID

Obtain a TypeID from a prefix and a UUID.

TypeID generation (class methods)

genID :: forall a m. (IDGen a, MonadIO m) => GenFunc (IDGenPrefix a) (IDGenReq a (m a))

Generate a new identifier with the given prefix.

genID' :: forall a m. (IDGen a, MonadIO m) => GenFunc (IDGenPrefix a) (IDGenReq a (m a))

Similar to genID, but stateless. It can be a faster implementation than genID, but it does not guarantee any stateful property, such as monotonically increasing for UUIDv7-based identifiers.

The default implementation is the same as genID.

genIDs :: forall a m. (IDGen a, MonadIO m) => GenFunc (IDGenPrefix a) (IDGenReq a (Word16 -> m [a]))

Generate a list of identifiers with the given prefix.

decorate :: forall a. IDGen a => GenFunc (IDGenPrefix a) (UUID -> ResWithErr (IDGenPrefix a) a)

Generate a new identifier with the given prefix and UUID suffix.

Validation (TypeID-specific)

checkPrefix :: Text -> Maybe TypeIDError

Check if the given prefix is a valid TypeID prefix.

checkTypeID :: TypeID -> Maybe TypeIDError

Check if the prefix is valid and the suffix UUID has the correct v7 version and variant.

checkTypeIDWithEnv :: MonadIO m => TypeID -> m (Maybe TypeIDError)

Similar to checkTypeID, but also checks if the suffix UUID is generated in the past.

Validation (class methods)

checkID :: forall a. IDGen a => a -> Maybe TypeIDError

Check the validity of the identifier.

checkIDWithEnv :: forall a m. (IDGen a, MonadIO m) => a -> m (Maybe TypeIDError)

Check the validity of the identifier, potentially with impure criteria.

Encoding & decoding (TypeID-specific)

toString :: TypeID -> String

Pretty-print a TypeID. It is id2String with concrete type.

toText :: TypeID -> Text

Pretty-print a TypeID to strict Text. It is id2Text with concrete type.

toByteString :: TypeID -> ByteString

Pretty-print a TypeID to lazy ByteString. It is id2ByteString with concrete type.

parseString :: String -> Either TypeIDError TypeID

Parse a TypeID from its String representation. It is string2ID with concrete type.

parseText :: Text -> Either TypeIDError TypeID

Parse a TypeID from its string representation as a strict Text. It is text2ID with concrete type.

parseByteString :: ByteString -> Either TypeIDError TypeID

Parse a TypeID from its string representation as a lazy ByteString. It is byteString2ID with concrete type.

parseStringM :: MonadIO m => String -> m TypeID

Parse a TypeID from its String representation, throwing an error when the parsing fails. It is string2IDM with concrete type.

parseTextM :: MonadIO m => Text -> m TypeID

Parse a TypeID from its string representation as a strict Text, throwing an error when the parsing fails. It is text2IDM with concrete type.

parseByteStringM :: MonadIO m => ByteString -> m TypeID

Parse a TypeID from its string representation as a lazy ByteString, throwing an error when the parsing fails. It is byteString2IDM with concrete type.

Encoding & decoding (class methods)

id2String :: IDConv a => a -> String

Pretty-print the identifier to a String.

id2Text :: IDConv a => a -> Text

Pretty-print the identifier to a strict Text.

id2ByteString :: IDConv a => a -> ByteString

Pretty-print the identifier to a lazy ByteString.

string2ID :: IDConv a => String -> Either TypeIDError a

Parse the identifier from its String representation.

text2ID :: IDConv a => Text -> Either TypeIDError a

Parse the identifier from its string representation as a strict Text.

byteString2ID :: IDConv a => ByteString -> Either TypeIDError a

Parse the identifier from its string representation as a lazy ByteString.

string2IDM :: (IDConv a, MonadIO m) => String -> m a

Parse the identifier from its String representation, throwing an error when the parsing fails.

text2IDM :: (IDConv a, MonadIO m) => Text -> m a

Parse the identifier from its string representation as a strict Text, throwing an error when the parsing fails.

byteString2IDM :: (IDConv a, MonadIO m) => ByteString -> m a

Parse the identifier from its string representation as a lazy ByteString, throwing an error when the parsing fails.