Data.TypeID.Class

A module with the APIs for any TypeID-ish identifier type.

It is not completed as most of the functions are still implemented individually in the Data.TypeID and Data.KindID modules.

Type classes

class IDType a where

A type class for a TypeID-ish identifier type, which has a Text prefix and a UUID suffix.

Methods

getPrefix :: a -> Text

Get the prefix of the identifier.

getUUID :: a -> UUID

Get the UUID suffix of the identifier.

getTime :: a -> Word64

Get the timestamp of the identifier.

Instances

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

(ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => IDType (KindID prefix)

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

Defined in Data.KindID.Internal

Methods

getPrefix :: KindID prefix -> Text

getUUID :: KindID prefix -> UUID

getTime :: KindID prefix -> Word64

class IDConv a where

A type class for converting between a TypeID-ish identifier type and some string representations.

Methods

string2ID :: String -> Either TypeIDError a

Parse the identifier from its String representation.

text2ID :: Text -> Either TypeIDError a

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

byteString2ID :: ByteString -> Either TypeIDError a

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

id2String :: a -> String

Pretty-print the identifier to a String.

id2Text :: a -> Text

Pretty-print the identifier to a strict Text.

id2ByteString :: a -> ByteString

Pretty-print the identifier to a lazy ByteString.

Instances

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

(ToPrefix prefix, ValidPrefix (PrefixSymbol prefix)) => IDConv (KindID prefix)

Conversion between KindID and StringTextByteString.

Defined in Data.KindID.Internal

Methods

string2ID :: String -> Either TypeIDError (KindID prefix)

text2ID :: Text -> Either TypeIDError (KindID prefix)

byteString2ID :: ByteString -> Either TypeIDError (KindID prefix)

id2String :: KindID prefix -> String

id2Text :: KindID prefix -> Text

id2ByteString :: KindID prefix -> ByteString