Headroom.Data.EnumExtra

Provides extra functionality for enum-like types, e.g. reading/writing from/to textual representation, etc.

Documentation

class (Bounded a, Enum a, Eq a, Ord a, Show a) => EnumExtra a where

Enum data type, capable to (de)serialize itself from/to string representation. Can be automatically derived by GHC using the DeriveAnyClass extension.

Minimal complete definition

Nothing

Methods

allValues :: [a]

Returns list of all enum values.

>>> data Test = Foo | Bar deriving (Bounded, Enum, EnumExtra, Eq, Ord, Show)
>>> allValues @Test
[Foo,Bar]

allValuesToText :: Text

Returns all values of enum as single string, individual values separated with comma.

>>> data Test = Foo | Bar deriving (Bounded, Enum, EnumExtra, Eq, Ord, Show)
>>> allValuesToText @Test
"Foo, Bar"

enumToText :: a -> Text

Returns textual representation of enum value. Opposite to textToEnum.

>>> data Test = Foo | Bar deriving (Bounded, Enum, EnumExtra, Eq, Ord, Show)
>>> enumToText Bar
"Bar"

textToEnum :: Text -> Maybe a

Returns enum value from its textual representation. Opposite to enumToText.

>>> data Test = Foo | Bar deriving (Bounded, Enum, EnumExtra, Eq, Ord, Show)
>>> (textToEnum "Foo") :: (Maybe Test)
Just Foo

Instances

EnumExtra FileType

Defined in Headroom.FileType.Types

Methods

allValues :: [FileType]

allValuesToText :: Text

enumToText :: FileType -> Text

textToEnum :: Text -> Maybe FileType

EnumExtra LicenseType

Defined in Headroom.Types

Methods

allValues :: [LicenseType]

allValuesToText :: Text

enumToText :: LicenseType -> Text

textToEnum :: Text -> Maybe LicenseType