Safe Haskell	None
Language	GHC2021

Freckle.App.TextualEnum

Description

Typical instances for enumerated data types with textual representation

Synopsis

newtype TextualEnum a = TextualEnum {
- enumValue :: a
}
class EnumValue a where
- toText :: a -> Text
class EnumName (a :: k) where
- enumName :: Proxy a -> Text
enums :: (Bounded a, Enum a) => NonEmpty (TextualEnum a)
fromText :: (EnumValue a, Bounded a, Enum a) => Text -> Maybe (TextualEnum a)
prop_roundTripEnumText :: (Bounded a, Enum a, EnumValue a, Eq a) => TextualEnum a -> Bool

Documentation

newtype TextualEnum a Source #

Wrapper around enums

N.B. This should not be used for "enormous" enumerations. It's primary purpose is to provide standard instances for discriminated-union-defined enums.

Constructors

TextualEnum
Fields enumValue :: a

Instances

Instances details

(Bounded a, Enum a) => Arbitrary (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

arbitrary :: Gen (TextualEnum a) #

shrink :: TextualEnum a -> [TextualEnum a] #

(EnumValue a, Bounded a, Enum a) => FromJSON (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

parseJSON :: Value -> Parser (TextualEnum a) #

parseJSONList :: Value -> Parser [TextualEnum a] #

omittedField :: Maybe (TextualEnum a) #

EnumValue a => ToJSON (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

toJSON :: TextualEnum a -> Value #

toEncoding :: TextualEnum a -> Encoding #

toJSONList :: [TextualEnum a] -> Value #

toEncodingList :: [TextualEnum a] -> Encoding #

omitField :: TextualEnum a -> Bool #

(Bounded a, Enum a, EnumValue a, Eq a) => HasCodec (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

codec :: JSONCodec (TextualEnum a) #

listCodecForStringCompatibility :: JSONCodec [TextualEnum a] #

Generic a => Generic (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Associated Types

type Rep (TextualEnum a)
Instance details Defined in Freckle.App.TextualEnum type Rep (TextualEnum a) = Rep a

Methods

from :: TextualEnum a -> Rep (TextualEnum a) x #

to :: Rep (TextualEnum a) x -> TextualEnum a #

Show a => Show (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

showsPrec :: Int -> TextualEnum a -> ShowS #

show :: TextualEnum a -> String #

showList :: [TextualEnum a] -> ShowS #

(EnumValue a, Bounded a, Enum a) => FromField (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

parseField :: Field -> Parser (TextualEnum a) #

EnumValue a => ToField (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

toField :: TextualEnum a -> Field #

Eq a => Eq (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

(==) :: TextualEnum a -> TextualEnum a -> Bool #

(/=) :: TextualEnum a -> TextualEnum a -> Bool #

Ord a => Ord (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

compare :: TextualEnum a -> TextualEnum a -> Ordering #

(<) :: TextualEnum a -> TextualEnum a -> Bool #

(<=) :: TextualEnum a -> TextualEnum a -> Bool #

(>) :: TextualEnum a -> TextualEnum a -> Bool #

(>=) :: TextualEnum a -> TextualEnum a -> Bool #

max :: TextualEnum a -> TextualEnum a -> TextualEnum a #

min :: TextualEnum a -> TextualEnum a -> TextualEnum a #

(Bounded a, Enum a, EnumValue a) => FromHttpApiData (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

parseUrlPiece :: Text -> Either Text (TextualEnum a) #

parseHeader :: ByteString -> Either Text (TextualEnum a) #

parseQueryParam :: Text -> Either Text (TextualEnum a) #

EnumValue a => ToHttpApiData (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

toUrlPiece :: TextualEnum a -> Text #

toEncodedUrlPiece :: TextualEnum a -> Builder #

toHeader :: TextualEnum a -> ByteString #

toQueryParam :: TextualEnum a -> Text #

toEncodedQueryParam :: TextualEnum a -> Builder #

(Bounded a, Enum a, EnumValue a) => ToParamSchema (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

toParamSchema :: Proxy (TextualEnum a) -> Schema #

(Bounded a, Enum a, EnumValue a, Typeable a, EnumName a) => ToSchema (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

declareNamedSchema :: Proxy (TextualEnum a) -> Declare (Definitions Schema) NamedSchema #

(EnumValue a, Bounded a, Enum a) => PathPiece (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

fromPathPiece :: Text -> Maybe (TextualEnum a) #

toPathPiece :: TextualEnum a -> Text #

(Bounded a, Enum a, EnumValue a) => PersistField (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

toPersistValue :: TextualEnum a -> PersistValue #

fromPersistValue :: PersistValue -> Either Text (TextualEnum a) #

(Bounded a, Enum a, EnumValue a) => PersistFieldSql (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

Methods

sqlType :: Proxy (TextualEnum a) -> SqlType #

type Rep (TextualEnum a) Source #

Instance details

Defined in Freckle.App.TextualEnum

type Rep (TextualEnum a) = Rep a

class EnumValue a where Source #

Methods

toText :: a -> Text Source #

Convert a TextualEnum to Text

class EnumName (a :: k) where Source #

Methods

enumName :: Proxy a -> Text Source #

Name of a TextualEnum, used for naming schemas

enums :: (Bounded a, Enum a) => NonEmpty (TextualEnum a) Source #

All values of a TextualEnum

fromText :: (EnumValue a, Bounded a, Enum a) => Text -> Maybe (TextualEnum a) Source #

Parse a TextualEnum from Text

prop_roundTripEnumText :: (Bounded a, Enum a, EnumValue a, Eq a) => TextualEnum a -> Bool Source #

Test that enum instances are coherent