Data.TypeID

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

Data types

data TypeID

The constructor is not exposed to the public API to prevent generating invalid TypeIDs.

Note that the Show instance is for debugging purposes only. To pretty-print a TypeID, 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.

Instances

Read TypeID

Defined in Data.TypeID.Internal

Methods

readsPrec :: Int -> ReadS TypeID

readList :: ReadS [TypeID]

readPrec :: ReadPrec TypeID

readListPrec :: ReadPrec [TypeID]

Show TypeID

Defined in Data.TypeID.Internal

Methods

showsPrec :: Int -> TypeID -> ShowS

show :: TypeID -> String

showList :: [TypeID] -> ShowS

Eq TypeID

Defined in Data.TypeID.Internal

Methods

(==) :: TypeID -> TypeID -> Bool

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

Ord TypeID

Defined in Data.TypeID.Internal

Methods

compare :: TypeID -> TypeID -> Ordering

(<) :: TypeID -> TypeID -> Bool

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

(>) :: TypeID -> TypeID -> Bool

(>=) :: TypeID -> TypeID -> Bool

max :: TypeID -> TypeID -> TypeID

min :: TypeID -> TypeID -> TypeID

Hashable TypeID

Defined in Data.TypeID.Internal

Methods

hashWithSalt :: Int -> TypeID -> Int

hash :: TypeID -> Int

IDConv TypeID

Conversion between TypeID and StringTextByteString.

Defined in Data.TypeID.Internal

Methods

string2ID :: String -> Either TypeIDError TypeID

text2ID :: Text -> Either TypeIDError TypeID

byteString2ID :: ByteString -> Either TypeIDError TypeID

id2String :: TypeID -> String

id2Text :: TypeID -> Text

id2ByteString :: TypeID -> ByteString

IDGen TypeID

Generate TypeIDs.

Defined in Data.TypeID.Internal

Associated Types

type IDGenPrefix TypeID :: Maybe Type

Methods

genID_ :: forall (m :: Type -> Type). MonadIO m => Proxy TypeID -> GenFunc (IDGenPrefix TypeID) (m TypeID)

genID'_ :: forall (m :: Type -> Type). MonadIO m => Proxy TypeID -> GenFunc (IDGenPrefix TypeID) (m TypeID)

genIDs_ :: forall (m :: Type -> Type). MonadIO m => Proxy TypeID -> GenFunc (IDGenPrefix TypeID) (Word16 -> m [TypeID])

decorate_ :: Proxy TypeID -> GenFunc (IDGenPrefix TypeID) (UUID -> ResWithErr (IDGenPrefix TypeID) TypeID)

checkID_ :: Proxy TypeID -> TypeID -> Maybe TypeIDError

checkIDWithEnv_ :: MonadIO m => Proxy TypeID -> TypeID -> m (Maybe TypeIDError)

IDType TypeID

Get the prefix, UUID, and timestamp of a TypeID.

Defined in Data.TypeID.Internal

Methods

getPrefix :: TypeID -> Text

getUUID :: TypeID -> UUID

getTime :: TypeID -> Word64

FromJSON TypeID

Defined in Data.TypeID.Internal

Methods

parseJSON :: Value -> Parser TypeID

parseJSONList :: Value -> Parser [TypeID]

omittedField :: Maybe TypeID

FromJSONKey TypeID

Defined in Data.TypeID.Internal

Methods

fromJSONKey :: FromJSONKeyFunction TypeID

fromJSONKeyList :: FromJSONKeyFunction [TypeID]

ToJSON TypeID

Defined in Data.TypeID.Internal

Methods

toJSON :: TypeID -> Value

toEncoding :: TypeID -> Encoding

toJSONList :: [TypeID] -> Value

toEncodingList :: [TypeID] -> Encoding

omitField :: TypeID -> Bool

ToJSONKey TypeID

Defined in Data.TypeID.Internal

Methods

toJSONKey :: ToJSONKeyFunction TypeID

toJSONKeyList :: ToJSONKeyFunction [TypeID]

type IDGenPrefix TypeID

Defined in Data.TypeID.Internal

type IDGenPrefix TypeID = 'Just Text

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)

nilTypeID :: TypeID

Deprecated: Will be removed in the next major release.

The nil TypeID.

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 statelesss 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) (m a)

Generate a new identifier with the given prefix.

genID' :: forall a m. (IDGen a, MonadIO m) => GenFunc (IDGenPrefix 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) (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.

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.