License	MIT
Maintainer	mmzk1526@outlook.com
Portability	GHC
Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.TypeID

Contents

Data types
TypeID generation (TypeID-specific)
TypeID generation (class methods)
Validation (TypeID-specific)
Validation (class methods)
Encoding & decoding (TypeID-specific)
Encoding & decoding (class methods)

Description

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

Synopsis

data TypeID
getPrefix :: IDType a => a -> Text
getUUID :: IDType a => a -> UUID
getTime :: IDType a => a -> Word64
nilTypeID :: TypeID
genTypeID :: MonadIO m => Text -> m TypeID
genTypeID' :: MonadIO m => Text -> m TypeID
genTypeIDs :: MonadIO m => Text -> Word16 -> m [TypeID]
decorateTypeID :: Text -> UUID -> Either TypeIDError TypeID
genID :: forall a m. (IDGen a, MonadIO m) => GenFunc (IDGenPrefix a) (m a)
genID' :: forall a m. (IDGen a, MonadIO m) => GenFunc (IDGenPrefix a) (m a)
genIDs :: forall a m. (IDGen a, MonadIO m) => GenFunc (IDGenPrefix a) (Word16 -> m [a])
decorate :: forall a. IDGen a => GenFunc (IDGenPrefix a) (UUID -> ResWithErr (IDGenPrefix a) a)
checkPrefix :: Text -> Maybe TypeIDError
checkTypeID :: TypeID -> Maybe TypeIDError
checkTypeIDWithEnv :: MonadIO m => TypeID -> m (Maybe TypeIDError)
checkID :: forall a. IDGen a => a -> Maybe TypeIDError
checkIDWithEnv :: forall a m. (IDGen a, MonadIO m) => a -> m (Maybe TypeIDError)
toString :: TypeID -> String
toText :: TypeID -> Text
toByteString :: TypeID -> ByteString
parseString :: String -> Either TypeIDError TypeID
parseText :: Text -> Either TypeIDError TypeID
parseByteString :: ByteString -> Either TypeIDError TypeID
parseStringM :: MonadIO m => String -> m TypeID
parseTextM :: MonadIO m => Text -> m TypeID
parseByteStringM :: MonadIO m => ByteString -> m TypeID
id2String :: IDConv a => a -> String
id2Text :: IDConv a => a -> Text
id2ByteString :: IDConv a => a -> ByteString
string2ID :: IDConv a => String -> Either TypeIDError a
text2ID :: IDConv a => Text -> Either TypeIDError a
byteString2ID :: IDConv a => ByteString -> Either TypeIDError a
string2IDM :: (IDConv a, MonadIO m) => String -> m a
text2IDM :: (IDConv a, MonadIO m) => Text -> m a
byteString2IDM :: (IDConv a, MonadIO m) => ByteString -> m a

Data types

data TypeID Source #

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

Instances

Instances details

Storable TypeID Source #	Similar to the `Binary` instance, but the `UUID` is stored in host endian.
Instance details Defined in Data.TypeID.Internal Methods sizeOf :: TypeID -> Int # alignment :: TypeID -> Int # peekElemOff :: Ptr TypeID -> Int -> IO TypeID # pokeElemOff :: Ptr TypeID -> Int -> TypeID -> IO () # peekByteOff :: Ptr b -> Int -> IO TypeID # pokeByteOff :: Ptr b -> Int -> TypeID -> IO () # peek :: Ptr TypeID -> IO TypeID # poke :: Ptr TypeID -> TypeID -> IO () #
Read TypeID Source #
Instance details Defined in Data.TypeID.Internal Methods readsPrec :: Int -> ReadS TypeID # readList :: ReadS [TypeID] # readPrec :: ReadPrec TypeID # readListPrec :: ReadPrec [TypeID] #
Show TypeID Source #
Instance details Defined in Data.TypeID.Internal Methods showsPrec :: Int -> TypeID -> ShowS # show :: TypeID -> String # showList :: [TypeID] -> ShowS #
Binary TypeID Source #	Since the specification does not formulate a concrete binary format, this instance is based on the following custom format: The first 16 bytes are the suffix `UUID` encoded in base32. The next byte is the length of the prefix encoded in a byte. The next bytes are the prefix, each letter taking 5 bits, mapping 'a' to 1 and 'z' to 26. Note that the prefix and the `UUID` is swapped compared to the string representation, this is for the convenience of the use case where only the suffix `UUID` is required. Because of this, the sorting order may be different from the string representation, but they are guaranteed to be the same if the same prefix is used.
Instance details Defined in Data.TypeID.Internal Methods put :: TypeID -> Put # get :: Get TypeID # putList :: [TypeID] -> Put #
Eq TypeID Source #
Instance details Defined in Data.TypeID.Internal Methods (==) :: TypeID -> TypeID -> Bool # (/=) :: TypeID -> TypeID -> Bool #
Ord TypeID Source #
Instance details 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 Source #
Instance details Defined in Data.TypeID.Internal Methods hashWithSalt :: Int -> TypeID -> Int # hash :: TypeID -> Int #
IDConv TypeID Source #	Conversion between `TypeID` and `String``Text``ByteString`.
Instance details Defined in Data.TypeID.Internal Methods string2ID :: String -> Either TypeIDError TypeID Source # text2ID :: Text -> Either TypeIDError TypeID Source # byteString2ID :: ByteString -> Either TypeIDError TypeID Source # id2String :: TypeID -> String Source # id2Text :: TypeID -> Text Source # id2ByteString :: TypeID -> ByteString Source # string2IDM :: MonadIO m => String -> m TypeID Source # text2IDM :: MonadIO m => Text -> m TypeID Source # byteString2IDM :: MonadIO m => ByteString -> m TypeID Source # unsafeString2ID :: String -> TypeID Source # unsafeText2ID :: Text -> TypeID Source # unsafeByteString2ID :: ByteString -> TypeID Source #
IDGen TypeID Source #	Generate `TypeID`s.
Instance details Defined in Data.TypeID.Internal Associated Types type IDGenPrefix TypeID :: Maybe Type Source # Methods genID_ :: forall (m :: Type -> Type). MonadIO m => Proxy TypeID -> GenFunc (IDGenPrefix TypeID) (m TypeID) Source # genID'_ :: forall (m :: Type -> Type). MonadIO m => Proxy TypeID -> GenFunc (IDGenPrefix TypeID) (m TypeID) Source # genIDs_ :: forall (m :: Type -> Type). MonadIO m => Proxy TypeID -> GenFunc (IDGenPrefix TypeID) (Word16 -> m [TypeID]) Source # decorate_ :: Proxy TypeID -> GenFunc (IDGenPrefix TypeID) (UUID -> ResWithErr (IDGenPrefix TypeID) TypeID) Source # checkID_ :: Proxy TypeID -> TypeID -> Maybe TypeIDError Source # checkIDWithEnv_ :: MonadIO m => Proxy TypeID -> TypeID -> m (Maybe TypeIDError) Source #
IDType TypeID Source #	Get the prefix, `UUID`, and timestamp of a `TypeID`.
Instance details Defined in Data.TypeID.Internal Methods getPrefix :: TypeID -> Text Source # getUUID :: TypeID -> UUID Source # getTime :: TypeID -> Word64 Source #
FromJSON TypeID Source #
Instance details Defined in Data.TypeID.Internal Methods parseJSON :: Value -> Parser TypeID # parseJSONList :: Value -> Parser [TypeID] # omittedField :: Maybe TypeID #
FromJSONKey TypeID Source #
Instance details Defined in Data.TypeID.Internal Methods fromJSONKey :: FromJSONKeyFunction TypeID # fromJSONKeyList :: FromJSONKeyFunction [TypeID] #
ToJSON TypeID Source #
Instance details Defined in Data.TypeID.Internal Methods toJSON :: TypeID -> Value # toEncoding :: TypeID -> Encoding # toJSONList :: [TypeID] -> Value # toEncodingList :: [TypeID] -> Encoding # omitField :: TypeID -> Bool #
ToJSONKey TypeID Source #
Instance details Defined in Data.TypeID.Internal Methods toJSONKey :: ToJSONKeyFunction TypeID # toJSONKeyList :: ToJSONKeyFunction [TypeID] #
type IDGenPrefix TypeID Source #
Instance details Defined in Data.TypeID.Internal type IDGenPrefix TypeID = 'Just Text

getPrefix :: IDType a => a -> Text Source #

Get the prefix of the identifier.

getUUID :: IDType a => a -> UUID Source #

Get the UUID suffix of the identifier.

getTime :: IDType a => a -> Word64 Source #

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

`TypeID` generation (`TypeID`-specific)

nilTypeID :: TypeID Source #

Deprecated: Will be removed in the next major release.

The nil TypeID.

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

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 Source #

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] Source #

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 Source #

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) Source #

Generate a new identifier with the given prefix.

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

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]) Source #

Generate a list of identifiers with the given prefix.

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

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

Validation (`TypeID`-specific)

checkPrefix :: Text -> Maybe TypeIDError Source #

Check if the given prefix is a valid TypeID prefix.

checkTypeID :: TypeID -> Maybe TypeIDError Source #

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

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

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 Source #

Check the validity of the identifier.

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

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

Encoding & decoding (`TypeID`-specific)

toString :: TypeID -> String Source #

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

toText :: TypeID -> Text Source #

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

toByteString :: TypeID -> ByteString Source #

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

parseString :: String -> Either TypeIDError TypeID Source #

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

parseText :: Text -> Either TypeIDError TypeID Source #

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

parseByteString :: ByteString -> Either TypeIDError TypeID Source #

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

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

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 Source #

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 Source #

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