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.

Instances

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

FromJSON TypeID

Defined in Data.TypeID

Methods

parseJSON :: Value -> Parser TypeID

parseJSONList :: Value -> Parser [TypeID]

ToJSON TypeID

Defined in Data.TypeID

Methods

toJSON :: TypeID -> Value

toEncoding :: TypeID -> Encoding

toJSONList :: [TypeID] -> Value

toEncodingList :: [TypeID] -> Encoding

getPrefix :: TypeID -> Text

Get the prefix of the TypeID.

getUUID :: TypeID -> UUID

Get the UUID of the TypeID.

getTime :: TypeID -> Word64

Get the timestamp of the TypeID.

data TypeIDError

Errors from parsing a TypeID.

Constructors

TypeIDErrorPrefixTooLong Int

TypeIDExtraSeparator

TypeIDErrorPrefixInvalidChar Char

TypeIDErrorAlreadyHasPrefix Text

TypeIDErrorPrefixMismatch Text Text

TypeIDErrorUUIDError

Instances

Exception TypeIDError

Defined in Data.TypeID.Internal

Methods

toException :: TypeIDError -> SomeException

fromException :: SomeException -> Maybe TypeIDError

displayException :: TypeIDError -> String

Show TypeIDError

Defined in Data.TypeID.Internal

Methods

showsPrec :: Int -> TypeIDError -> ShowS

show :: TypeIDError -> String

showList :: [TypeIDError] -> ShowS

Eq TypeIDError

Defined in Data.TypeID.Internal

Methods

(==) :: TypeIDError -> TypeIDError -> Bool

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

Ord TypeIDError

Defined in Data.TypeID.Internal

Methods

compare :: TypeIDError -> TypeIDError -> Ordering

(<) :: TypeIDError -> TypeIDError -> Bool

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

(>) :: TypeIDError -> TypeIDError -> Bool

(>=) :: TypeIDError -> TypeIDError -> Bool

max :: TypeIDError -> TypeIDError -> TypeIDError

min :: TypeIDError -> TypeIDError -> TypeIDError

TypeID generation

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

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

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.

nil :: TypeID

The nil TypeID.

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

Obtain a TypeID from a prefix and a UUID.

Prefix validation

checkPrefix :: Text -> Maybe TypeIDError

Check if the given prefix is a valid TypeID prefix.

Encoding & decoding

toString :: TypeID -> String

Pretty-print a TypeID.

toText :: TypeID -> Text

Pretty-print a TypeID to strict Text.

toByteString :: TypeID -> ByteString

Pretty-print a TypeID to lazy ByteString.

parseString :: String -> Either TypeIDError TypeID

Parse a TypeID from its String representation.

parseText :: Text -> Either TypeIDError TypeID

Parse a TypeID from its string representation as a strict Text.

parseByteString :: ByteString -> Either TypeIDError TypeID

Parse a TypeID from its string representation as a lazy ByteString.

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

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

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

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

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

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

Orphan instances

FromJSON TypeID

Methods

parseJSON :: Value -> Parser TypeID

parseJSONList :: Value -> Parser [TypeID]

ToJSON TypeID

Methods

toJSON :: TypeID -> Value

toEncoding :: TypeID -> Encoding

toJSONList :: [TypeID] -> Value

toEncodingList :: [TypeID] -> Encoding