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

Data.TypeID

Contents

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

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
nil :: TypeID
nilTypeID :: TypeID
genTypeID :: Text -> IO TypeID
genTypeIDs :: Text -> Word16 -> IO [TypeID]
decorate :: Text -> UUID -> Either TypeIDError TypeID
decorateTypeID :: Text -> UUID -> Either TypeIDError TypeID
checkPrefix :: Text -> Maybe TypeIDError
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
toString :: TypeID -> String
toText :: TypeID -> Text
toByteString :: TypeID -> ByteString
parseString :: String -> Either TypeIDError TypeID
parseText :: Text -> Either TypeIDError TypeID
parseByteString :: ByteString -> Either TypeIDError TypeID
parseStringWithPrefix :: Text -> String -> Either TypeIDError TypeID
parseTextWithPrefix :: Text -> Text -> Either TypeIDError TypeID
parseByteStringWithPrefix :: Text -> ByteString -> Either TypeIDError TypeID

Data types

data TypeID Source #

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

Instances details

Show TypeID Source #
Instance details Defined in Data.TypeID.Internal Methods showsPrec :: Int -> TypeID -> ShowS # show :: TypeID -> String # showList :: [TypeID] -> ShowS #
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 #
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 #
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] #

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.

TypeID generation

nil :: TypeID Source #

Deprecated: Use nilTypeID instead.

The nil TypeID.

nilTypeID :: TypeID Source #

The nil TypeID.

genTypeID :: Text -> IO 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.

genTypeIDs :: Text -> Word16 -> IO [TypeID] Source #

Generate n 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.

decorate :: Text -> UUID -> Either TypeIDError TypeID Source #

Deprecated: Use decorateTypeID instead.

Obtain a TypeID from a prefix and a UUID.

decorateTypeID :: Text -> UUID -> Either TypeIDError TypeID Source #

Obtain a TypeID from a prefix and a UUID.

Prefix validation

checkPrefix :: Text -> Maybe TypeIDError Source #

Check if the given prefix is a valid TypeID prefix.

Encoding & decoding (class methods)

id2String :: IDConv a => a -> String Source #

Pretty-print the identifier to a String.

id2Text :: IDConv a => a -> Text Source #

Pretty-print the identifier to a strict Text.

id2ByteString :: IDConv a => a -> ByteString Source #

Pretty-print the identifier to a lazy ByteString.

string2ID :: IDConv a => String -> Either TypeIDError a Source #

Parse the identifier from its String representation.

text2ID :: IDConv a => Text -> Either TypeIDError a Source #

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

byteString2ID :: IDConv a => ByteString -> Either TypeIDError a Source #

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

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.

parseStringWithPrefix :: Text -> String -> Either TypeIDError TypeID Source #

Deprecated: Use parseString and decorate instead

Parse a TypeID from the given prefix and the String representation of a suffix.

parseTextWithPrefix :: Text -> Text -> Either TypeIDError TypeID Source #

Deprecated: Use parseText and decorate instead

Parse a TypeID from the given prefix and the string representation of a suffix as a strict Text.

parseByteStringWithPrefix :: Text -> ByteString -> Either TypeIDError TypeID Source #

Deprecated: Use parseByteString and decorate instead

Parse a TypeID from the given prefix and the string representation of a suffix as a lazy ByteString.