A TypeID with the prefix encoded at type level.

It is dubbed KindID because we the prefix here is a data kind rather than a type.

Note that the Show instance is for debugging purposes only. To pretty-print a KindID, use toString, toText or toByteString. However, this behaviour will be changed in the next major version as it is not useful. By then, the Show instance will be the same as toString.

Get the prefix of the identifier.

Get the UUID suffix of the identifier.

Get the timestamp of the identifier.

A constraint for valid prefix Symbols.

A class that translates any kind to a Symbol. It is used to translate custom data kinds to a Symbol so that they can be used as KindID prefixes.

For example, suppose we have the following data structure that represents the prefixes we are going to use:

data Prefix = User | Post | Comment

Then we can make it an instance of ToPrefix like this:

instance ToPrefix 'User where
  type PrefixSymbol 'User = "user"

instance ToPrefix 'Post where
  type PrefixSymbol 'Post = "post"

instance ToPrefix 'Comment where
  type PrefixSymbol 'Comment = "comment"

Now we can use Prefix as a prefix for KindIDs, e.g.

do
  userID <- genKindID @'User -- Same as genKindID @"user"
  postID <- genKindID @'Post -- Same as genKindID @"post"
  commentID <- genKindID @'Comment -- Same as genKindID @"comment"

The nil KindID.

The nil KindID.

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

Generate n KindIDs from a prefix.

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

Obtain a KindID from a prefix and a UUID.

Obtain a KindID from a prefix and a UUID.

Pretty-print the identifier to a String.

Pretty-print the identifier to a strict Text.

Pretty-print the identifier to a lazy ByteString.

Parse the identifier from its String representation.

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

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

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

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

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

Parse a KindID from its String representation. It is parseString with concrete type.

Parse a KindID from its string representation as a strict Text. It is parseText with concrete type.

Parse a KindID from its string representation as a lazy ByteString. It is parseByteString with concrete type.

Convert a KindID to a TypeID.

Convert a TypeID to a KindID. If the actual prefix does not match with the expected one as defined by the type, it returns Nothing.