Data.TypeID.V5

TypeID with UUIDv5.

Data types

type TypeIDV5 = TypeID' 'V5

Similar to TypeID, but uses UUIDv5.

getPrefix :: IDType a => a -> Text

Get the prefix of the identifier.

getUUID :: IDType a => a -> UUID

Get the UUID suffix of the identifier.

TypeIDV5 generation (TypeIDV5-specific)

genTypeID :: MonadIO m => Text -> UUID -> [Word8] -> m TypeIDV5

Generate a new TypeIDV5 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.

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

Obtain a TypeIDV5 from a prefix and a UUID.

TypeIDV5 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.

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 (TypeIDV5-specific)

checkPrefix :: Text -> Maybe TypeIDError

Check if the given prefix is a valid TypeIDV5 prefix.

checkTypeID :: TypeIDV5 -> Maybe TypeIDError

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

Validation (class methods)

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

Check the validity of the identifier.

Encoding & decoding (TypeIDV5-specific)

toString :: TypeIDV5 -> String

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

toText :: TypeIDV5 -> Text

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

toByteString :: TypeIDV5 -> ByteString

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

parseString :: String -> Either TypeIDError TypeIDV5

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

parseText :: Text -> Either TypeIDError TypeIDV5

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

parseByteString :: ByteString -> Either TypeIDError TypeIDV5

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

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

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

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

Parse a TypeIDV5 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 TypeIDV5

Parse a TypeIDV5 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.