WebApi.Param

Contents

• Serialization
• Deserialization
• Wrappers
• Helpers
• Generic (De)Serialization fn

Description

encodeParam 5 == "5"

data Foo = Foo { foo :: Int }
         deriving (Show, Eq, Generic)

data Bar = Bar { bar :: Foo }
         deriving (Show, Eq, Generic)

instance ToParam Foo 'FormParam
instance ToParam Bar 'FormParam

toParam (Proxy :: Proxy 'FormParam) "" (Bar (Foo 5)) == [("bar.foo","5")]

Synopsis

• class ToParam parK a where
  • toParam :: Proxy (parK :: ParamK) -> ByteString -> a -> [SerializedData parK]
• class EncodeParam t where
  • encodeParam :: t -> ByteString
• class ToHeader a where
  • toHeader :: a -> [Header]
• type family SerializedData par
• toQueryParam :: ToParam QueryParam a => a -> Query
• toFormParam :: ToParam FormParam a => a -> [(ByteString, ByteString)]
• toFileParam :: ToParam FileParam a => a -> [(ByteString, FileInfo FilePath)]
• toPathParam :: ToParam PathParam a => a -> [ByteString]
• toCookie :: ToParam Cookie a => a -> [(ByteString, CookieInfo ByteString)]
• toNonNestedParam :: ToParam parK (NonNested a) => Proxy (parK :: ParamK) -> ByteString -> a -> [SerializedData parK]
• class FromParam parK a where
  • fromParam :: Proxy (parK :: ParamK) -> ByteString -> Trie (DeSerializedData parK) -> Validation [ParamErr] a
• class DecodeParam t where
  • decodeParam :: ByteString -> Maybe t
• class FromHeader a where
  • fromHeader :: [Header] -> Validation [ParamErr] a
• newtype Validation e a = Validation {
  • getValidation :: Either e a
  }
• data ParamErr
  • = NotFound ByteString
  • | ParseErr ByteString Text
• class ParamErrToApiErr apiErr where
  • toApiErr :: [ParamErr] -> apiErr
• type family DeSerializedData par
• fromQueryParam :: FromParam QueryParam a => Query -> Validation [ParamErr] a
• fromFormParam :: FromParam FormParam a => [(ByteString, ByteString)] -> Validation [ParamErr] a
• fromFileParam :: FromParam FileParam a => [(ByteString, FileInfo FilePath)] -> Validation [ParamErr] a
• fromCookie :: FromParam Cookie a => [(ByteString, ByteString)] -> Validation [ParamErr] a
• lookupParam :: Proxy (parK :: ParamK) -> ByteString -> Trie (DeSerializedData parK) -> Maybe (DeSerializedData parK)
• fromNonNestedParam :: FromParam parK (NonNested a) => Proxy (parK :: ParamK) -> ByteString -> Trie (DeSerializedData parK) -> Validation [ParamErr] a
• data CookieInfo a = CookieInfo {
  • cookieValue :: a
  • cookiePath :: Maybe ByteString
  • cookieExpires :: Maybe UTCTime
  • cookieMaxAge :: Maybe DiffTime
  • cookieDomain :: Maybe ByteString
  • cookieHttpOnly :: Maybe Bool
  • cookieSecure :: Maybe Bool
  }
• newtype JsonOf a = JsonOf {
  • getValue :: a
  }
• newtype OptValue a = OptValue {
  • toMaybe :: Maybe a
  }
• newtype FileInfo = FileInfo {
  • fileInfo :: FileInfo FilePath
  }
• newtype NonNested a = NonNested {
  • getNonNestedParam :: a
  }
• data ParamK
  • = QueryParam
  • | FormParam
  • | FileParam
  • | PathParam
  • | Cookie
• data ParamSettings
• fieldModifier :: ParamSettings -> ByteString -> ByteString
• filePath :: FileInfo -> FilePath
• nest :: ByteString -> ByteString -> ByteString
• defaultParamSettings :: ParamSettings
• genericToQueryParam :: (Generic a, GToParam (Rep a) QueryParam) => ParamSettings -> ByteString -> a -> [QueryItem]
• genericFromQueryParam :: (Generic a, GFromParam (Rep a) QueryParam) => ParamSettings -> ByteString -> Trie (Maybe ByteString) -> Validation [ParamErr] a
• genericToFormParam :: (Generic a, GToParam (Rep a) FormParam) => ParamSettings -> ByteString -> a -> [(ByteString, ByteString)]
• genericFromFormParam :: (Generic a, GFromParam (Rep a) FormParam) => ParamSettings -> ByteString -> Trie ByteString -> Validation [ParamErr] a
• genericToFileParam :: (Generic a, GToParam (Rep a) FileParam) => ParamSettings -> ByteString -> a -> [(ByteString, FileInfo FilePath)]
• genericFromFileParam :: (Generic a, GFromParam (Rep a) FileParam) => ParamSettings -> ByteString -> Trie (FileInfo FilePath) -> Validation [ParamErr] a
• genericToPathParam :: (Generic a, GToParam (Rep a) PathParam) => ParamSettings -> ByteString -> a -> [ByteString]
• genericFromPathParam :: (Generic a, GFromParam (Rep a) PathParam) => ParamSettings -> ByteString -> Trie ByteString -> Validation [ParamErr] a
• genericToCookie :: (Generic a, GToParam (Rep a) Cookie) => ParamSettings -> ByteString -> a -> [(ByteString, CookieInfo ByteString)]
• genericFromCookie :: (Generic a, GFromParam (Rep a) Cookie) => ParamSettings -> ByteString -> Trie ByteString -> Validation [ParamErr] a

Serialization

Deserialization

Wrappers

Helpers

nest "pfx" "key" == "pfx.key"
nest "" "key" == "key"

Generic (De)Serialization fn