Safe Haskell	Safe-Inferred
Language	GHC2021

Web.Hyperbole.Data.Param

Synopsis

newtype Param = Param {
- text :: Text
}
newtype ParamValue = ParamValue {
- value :: Text
}
class ToParam a where
- toParam :: a -> ParamValue
class FromParam a where
- parseParam :: ParamValue -> Either String a
- decodeFormValue :: Maybe Text -> Either String a
parseQueryParam :: FromHttpApiData a => ParamValue -> Either String a
toQueryParam :: ToHttpApiData a => a -> ParamValue
showParam :: Show a => a -> ParamValue
readParam :: Read a => ParamValue -> Either String a
genericToParam :: (Generic a, GToJSON Zero (Rep a)) => a -> ParamValue
genericParseParam :: (Generic a, GFromJSON Zero (Rep a)) => ParamValue -> Either String a
jsonOptions :: Options
jsonParam :: ToJSON a => a -> ParamValue
jsonParse :: FromJSON a => ParamValue -> Either String a

Documentation

newtype Param Source #

Constructors

Param
Fields text :: Text

Instances

Instances details

IsString Param Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods fromString :: String -> Param #
Show Param Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods showsPrec :: Int -> Param -> ShowS # show :: Param -> String # showList :: [Param] -> ShowS #
Eq Param Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods (==) :: Param -> Param -> Bool # (/=) :: Param -> Param -> Bool #
Ord Param Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods compare :: Param -> Param -> Ordering # (<) :: Param -> Param -> Bool # (<=) :: Param -> Param -> Bool # (>) :: Param -> Param -> Bool # (>=) :: Param -> Param -> Bool # max :: Param -> Param -> Param # min :: Param -> Param -> Param #

newtype ParamValue Source #

Encode arbitrarily complex data into url form encoded data

Constructors

ParamValue
Fields value :: Text

Instances

Instances details

IsString ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods fromString :: String -> ParamValue #
Generic ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Param Associated Types type Rep ParamValue :: Type -> Type # Methods from :: ParamValue -> Rep ParamValue x # to :: Rep ParamValue x -> ParamValue #
Show ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods showsPrec :: Int -> ParamValue -> ShowS # show :: ParamValue -> String # showList :: [ParamValue] -> ShowS #
Eq ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods (==) :: ParamValue -> ParamValue -> Bool # (/=) :: ParamValue -> ParamValue -> Bool #
Ord ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods compare :: ParamValue -> ParamValue -> Ordering # (<) :: ParamValue -> ParamValue -> Bool # (<=) :: ParamValue -> ParamValue -> Bool # (>) :: ParamValue -> ParamValue -> Bool # (>=) :: ParamValue -> ParamValue -> Bool # max :: ParamValue -> ParamValue -> ParamValue # min :: ParamValue -> ParamValue -> ParamValue #
FromEncoded ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods parseEncoded :: Encoded -> Either String ParamValue Source #
ToEncoded ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Encoded Methods toEncoded :: ParamValue -> Encoded Source #
FromParam ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String ParamValue Source # decodeFormValue :: Maybe Text -> Either String ParamValue Source #
ToParam ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: ParamValue -> ParamValue Source #
type Rep ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Param type Rep ParamValue = D1 ('MetaData "ParamValue" "Web.Hyperbole.Data.Param" "hyperbole-0.6.0-inplace" 'True) (C1 ('MetaCons "ParamValue" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

class ToParam a where Source #

sessions, forms, and querys all encode data as query strings. ToParam and FromParam control how a datatype is encoded to a parameter. - This is equivalent to Web.HttpApiData, which is missing some instances and has some strange defaults

data AppColor
  = White
  | Red
  | Green
  deriving (Show, Generic, ToParam, FromParam)

Minimal complete definition

Nothing

Methods

toParam :: a -> ParamValue Source #

default toParam :: (Generic a, GToJSON Zero (Rep a)) => a -> ParamValue Source #

Instances

Instances details

ToParam Word16 Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Word16 -> ParamValue Source #
ToParam Word32 Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Word32 -> ParamValue Source #
ToParam Word64 Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Word64 -> ParamValue Source #
ToParam Word8 Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Word8 -> ParamValue Source #
ToParam ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: ParamValue -> ParamValue Source #
ToParam Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toParam :: Authenticated -> ParamValue Source #
ToParam Scopes Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toParam :: Scopes -> ParamValue Source #
ToParam TokenType Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods toParam :: TokenType -> ParamValue Source #
ToParam URI Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: URI -> ParamValue Source #
ToParam Value Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Value -> ParamValue Source #
ToParam Text Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Text -> ParamValue Source #
ToParam UTCTime Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: UTCTime -> ParamValue Source #
ToParam String Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: String -> ParamValue Source #
ToParam Integer Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Integer -> ParamValue Source #
ToParam Bool Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Bool -> ParamValue Source #
ToParam Char Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Char -> ParamValue Source #
ToParam Double Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Double -> ParamValue Source #
ToParam Float Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Float -> ParamValue Source #
ToParam Int Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Int -> ParamValue Source #
ToParam Word Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Word -> ParamValue Source #
ToParam a => ToParam (Maybe a) Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Maybe a -> ParamValue Source #
ToParam a => ToParam [a] Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: [a] -> ParamValue Source #
(ToParam a, ToParam b) => ToParam (Either a b) Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: Either a b -> ParamValue Source #
ToParam (Token a) Source #
Instance details Defined in Web.Hyperbole.Effect.GenRandom Methods toParam :: Token a -> ParamValue Source #
ToParam (FieldName a) Source #
Instance details Defined in Web.Hyperbole.HyperView.Forms Methods toParam :: FieldName a -> ParamValue Source #
(ToParam a, ToParam b) => ToParam (a, b) Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: (a, b) -> ParamValue Source #

class FromParam a where Source #

Decode data from a query, session, or form parameter value

data AppColor
  = White
  | Red
  | Green
  deriving (Show, Generic, ToParam, FromParam)

Minimal complete definition

Nothing

Methods

parseParam :: ParamValue -> Either String a Source #

default parseParam :: (Generic a, GFromJSON Zero (Rep a)) => ParamValue -> Either String a Source #

decodeFormValue :: Maybe Text -> Either String a Source #

Instances

Instances details

FromParam Word16 Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Word16 Source # decodeFormValue :: Maybe Text -> Either String Word16 Source #
FromParam Word32 Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Word32 Source # decodeFormValue :: Maybe Text -> Either String Word32 Source #
FromParam Word64 Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Word64 Source # decodeFormValue :: Maybe Text -> Either String Word64 Source #
FromParam Word8 Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Word8 Source # decodeFormValue :: Maybe Text -> Either String Word8 Source #
FromParam ParamValue Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String ParamValue Source # decodeFormValue :: Maybe Text -> Either String ParamValue Source #
FromParam Authenticated Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseParam :: ParamValue -> Either String Authenticated Source # decodeFormValue :: Maybe Text -> Either String Authenticated Source #
FromParam Scopes Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseParam :: ParamValue -> Either String Scopes Source # decodeFormValue :: Maybe Text -> Either String Scopes Source #
FromParam TokenType Source #
Instance details Defined in Web.Hyperbole.Effect.OAuth2 Methods parseParam :: ParamValue -> Either String TokenType Source # decodeFormValue :: Maybe Text -> Either String TokenType Source #
FromParam URI Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String URI Source # decodeFormValue :: Maybe Text -> Either String URI Source #
FromParam Value Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Value Source # decodeFormValue :: Maybe Text -> Either String Value Source #
FromParam Text Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Text Source # decodeFormValue :: Maybe Text -> Either String Text Source #
FromParam UTCTime Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String UTCTime Source # decodeFormValue :: Maybe Text -> Either String UTCTime Source #
FromParam String Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String String Source # decodeFormValue :: Maybe Text -> Either String String Source #
FromParam Integer Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Integer Source # decodeFormValue :: Maybe Text -> Either String Integer Source #
FromParam Bool Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Bool Source # decodeFormValue :: Maybe Text -> Either String Bool Source #
FromParam Char Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Char Source # decodeFormValue :: Maybe Text -> Either String Char Source #
FromParam Double Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Double Source # decodeFormValue :: Maybe Text -> Either String Double Source #
FromParam Float Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Float Source # decodeFormValue :: Maybe Text -> Either String Float Source #
FromParam Int Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Int Source # decodeFormValue :: Maybe Text -> Either String Int Source #
FromParam Word Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String Word Source # decodeFormValue :: Maybe Text -> Either String Word Source #
FromParam (Maybe Text) Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String (Maybe Text) Source # decodeFormValue :: Maybe Text -> Either String (Maybe Text) Source #
FromParam a => FromParam (Maybe a) Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String (Maybe a) Source # decodeFormValue :: Maybe Text -> Either String (Maybe a) Source #
FromParam a => FromParam [a] Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String [a] Source # decodeFormValue :: Maybe Text -> Either String [a] Source #
(FromParam a, FromParam b) => FromParam (Either a b) Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String (Either a b) Source # decodeFormValue :: Maybe Text -> Either String (Either a b) Source #
FromParam (Token a) Source #
Instance details Defined in Web.Hyperbole.Effect.GenRandom Methods parseParam :: ParamValue -> Either String (Token a) Source # decodeFormValue :: Maybe Text -> Either String (Token a) Source #
FromParam (FieldName a) Source #
Instance details Defined in Web.Hyperbole.HyperView.Forms Methods parseParam :: ParamValue -> Either String (FieldName a) Source # decodeFormValue :: Maybe Text -> Either String (FieldName a) Source #
(FromParam a, FromParam b) => FromParam (a, b) Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String (a, b) Source # decodeFormValue :: Maybe Text -> Either String (a, b) Source #

parseQueryParam :: FromHttpApiData a => ParamValue -> Either String a Source #

toQueryParam :: ToHttpApiData a => a -> ParamValue Source #

showParam :: Show a => a -> ParamValue Source #

Encode a Show as a query param

readParam :: Read a => ParamValue -> Either String a Source #

Decode a Read as a query param

genericToParam :: (Generic a, GToJSON Zero (Rep a)) => a -> ParamValue Source #

genericParseParam :: (Generic a, GFromJSON Zero (Rep a)) => ParamValue -> Either String a Source #

jsonOptions :: Options Source #

jsonParam :: ToJSON a => a -> ParamValue Source #

jsonParse :: FromJSON a => ParamValue -> Either String a Source #