Data.Apiary.Param

Contents

• route path parameter
• query parameter
• request parameter
• Strategy
• Proxies
  • strategy

Synopsis

• class Path a where
  • readPath :: Text -> Maybe a
  • pathRep :: proxy a -> TypeRep
• readPathAs :: Path a => proxy a -> Text -> Maybe a
• class Query a where
  • readQuery :: Maybe ByteString -> Maybe a
  • queryRep :: proxy a -> QueryRep
  • qTypeRep :: proxy a -> TypeRep
• data QueryRep
  • = Strict TypeRep
  • | Nullable TypeRep
  • | Check
  • | NoValue
• data File = File {
  • fileParameter :: ByteString
  • fileName :: ByteString
  • fileContentType :: ByteString
  • fileContent :: ByteString
  }
• type Param = (ByteString, ByteString)
• class ReqParam a where
  • reqParams :: proxy a -> Query -> [Param] -> [File] -> [(ByteString, Maybe a)]
  • reqParamRep :: proxy a -> QueryRep
• class Strategy w where
  • type SNext w k a prms :: [Elem]
  • strategy :: (KnownSymbol k, NotMember k prms, MonadPlus m) => w a -> proxy' k -> [Maybe a] -> Dict prms -> m (Dict (SNext w k a prms))
  • strategyRep :: w a -> StrategyRep
• newtype StrategyRep = StrategyRep {
  • strategyInfo :: Text
  }
• data First a = First
• data One a = One
• data Many a = Many
• data Some a = Some
• data Option a = Option
• data Optional a = Optional Text a
• pBool :: Proxy Bool
• pInt :: Proxy Int
• pWord :: Proxy Word
• pDouble :: Proxy Double
• pText :: Proxy Text
• pLazyText :: Proxy Text
• pByteString :: Proxy ByteString
• pLazyByteString :: Proxy ByteString
• pString :: Proxy String
• pMaybe :: proxy a -> Proxy (Maybe a)
• pFile :: Proxy File
• pFirst :: proxy a -> First a
• pOne :: proxy a -> One a
• pMany :: proxy a -> Many a
• pSome :: proxy a -> Some a
• pOption :: proxy a -> Option a
• pOptional :: Show a => a -> Optional a

route path parameter

query parameter

request parameter

Strategy

Proxies

strategy