Data.KindID.V4

KindID with UUIDv4.

Data types

type KindIDV4 = KindID' 'V4

Similar to KindID, but uses UUIDv4.

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.

KindIDV4 generation (KindIDV4-specific)

genKindID :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix), MonadIO m) => m (KindIDV4 prefix)

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

genKindID' :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix), MonadIO m) => m (KindIDV4 prefix)

Generate a new KindIDV4 from a prefix based on insecure UUIDv4.

decorateKindID :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => UUID -> KindIDV4 prefix

Obtain a KindIDV4 from a prefix and a UUID.

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

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

checkKindID :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => KindIDV4 prefix -> Maybe TypeIDError

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

Validation (class methods)

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

Check the validity of the identifier.

Encoding & decoding (KindIDV4-specific)

toString :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => KindIDV4 prefix -> String

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

toText :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => KindIDV4 prefix -> Text

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

toByteString :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => KindIDV4 prefix -> ByteString

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

parseString :: forall prefix. (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => String -> Either TypeIDError (KindIDV4 prefix)

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

parseText :: forall prefix. (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => Text -> Either TypeIDError (KindIDV4 prefix)

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

parseByteString :: forall prefix. (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => ByteString -> Either TypeIDError (KindIDV4 prefix)

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

parseStringM :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix), MonadIO m) => String -> m (KindIDV4 prefix)

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

parseTextM :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix), MonadIO m) => Text -> m (KindIDV4 prefix)

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

parseByteStringM :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix), MonadIO m) => ByteString -> m (KindIDV4 prefix)

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

Type-level & term-level conversion

toTypeID :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => KindIDV4 prefix -> TypeIDV4

Convert a KindIDV4 to a TypeIDV4.

fromTypeID :: (ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => TypeIDV4 -> Maybe (KindIDV4 prefix)

Convert a TypeIDV4 to a KindIDV4. Returns Nothing if the prefix does not match.