hyperbole

Safe Haskell	None
Language	GHC2021

Web.Hyperbole.Data.Argument

Synopsis

data Argument = JSON Value
toArgument :: ToJSON a => a -> Argument
parseArgument :: FromJSON a => Argument -> Either String a
argumentParser :: Parser Argument
decodeToArgument :: Text -> Either String Argument
decodeArgument :: FromJSON a => Text -> Either String a
encodeArgument :: ToJSON a => a -> Text
encodeFromArgument :: Argument -> Text
encodeJSON :: Value -> Text

Documentation

data Argument Source #

Constructors

Instances

Instances details

Generic Argument Source #

Instance details

Defined in Web.Hyperbole.Data.Argument

Associated Types

type Rep Argument
Instance details Defined in Web.Hyperbole.Data.Argument type Rep Argument = D1 ('MetaData "Argument" "Web.Hyperbole.Data.Argument" "hyperbole-0.7.1-inplace" 'False) (C1 ('MetaCons "JSON" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)))

Methods

from :: Argument -> Rep Argument x #

to :: Rep Argument x -> Argument #

Show Argument Source #

Instance details

Defined in Web.Hyperbole.Data.Argument

Methods

showsPrec :: Int -> Argument -> ShowS #

show :: Argument -> String #

showList :: [Argument] -> ShowS #

Eq Argument Source #

Instance details

Defined in Web.Hyperbole.Data.Argument

Methods

(==) :: Argument -> Argument -> Bool #

(/=) :: Argument -> Argument -> Bool #

Ord Argument Source #

Instance details

Defined in Web.Hyperbole.Data.Argument

Methods

compare :: Argument -> Argument -> Ordering #

(<) :: Argument -> Argument -> Bool #

(<=) :: Argument -> Argument -> Bool #

(>) :: Argument -> Argument -> Bool #

(>=) :: Argument -> Argument -> Bool #

max :: Argument -> Argument -> Argument #

min :: Argument -> Argument -> Argument #

FromEncoded Argument Source #

Instance details

Defined in Web.Hyperbole.Data.Encoded

Methods

parseEncoded :: Encoded -> Either String Argument Source #

ToEncoded Argument Source #

Instance details

Defined in Web.Hyperbole.Data.Encoded

Methods

toEncoded :: Argument -> Encoded Source #

type Rep Argument Source #

Instance details

Defined in Web.Hyperbole.Data.Argument

type Rep Argument = D1 ('MetaData "Argument" "Web.Hyperbole.Data.Argument" "hyperbole-0.7.1-inplace" 'False) (C1 ('MetaCons "JSON" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)))

toArgument :: ToJSON a => a -> Argument Source #

parseArgument :: FromJSON a => Argument -> Either String a Source #

argumentParser :: Parser Argument Source #

Parses both json and our custom constructor format

decodeToArgument :: Text -> Either String Argument Source #

decodeArgument :: FromJSON a => Text -> Either String a Source #

encodeArgument :: ToJSON a => a -> Text Source #

encodeFromArgument :: Argument -> Text Source #

JSON Encode argument, but alter it slightly to use raw strings for constructors without parameters, and switch to two-element sum encoding

encodeJSON :: Value -> Text Source #

Encodes as JSON for simple values, but forces constructors into our custom show-like format