circuithub/rel8
1
1
Fork 0
mirror of https://github.com/circuithub/rel8.git synced 2024-09-11 16:05:41 +03:00
Code Issues Projects Releases Wiki Activity

Document DBEnum

Browse Source
This commit is contained in:
Ollie Charles 2021-06-18 10:52:22 +01:00
parent 7133acedfe
commit 32395d07b0
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/Rel8/Type/Enum.hs
View File

@ -91,11 +91,16 @@ instance DBEnum a => DBMax (Enum a)
instance DBEnum a => DBMin (Enum a)
-- | @DBEnum@ contains the necessary metadata to describe a PostgreSQL @enum@ type.
type DBEnum :: Type -> Constraint
class (DBType a, Enumable a) => DBEnum a where
-- | Map Haskell values to the corresponding element of the @enum@ type. The
-- default implementation of this method will use the exact name of the
-- Haskell constructors.
enumValue :: a -> String
enumValue = gshow @(Rep a) . from
-- | The name of the PostgreSQL @enum@ type that @a@ maps to.
enumTypeName :: String