servant-routes-0.1.0.0: Generate route descriptions from Servant APIs
Copyright(c) Frederick Pringle 2024
LicenseBSD-3-Clause
Maintainerfreddyjepringle@gmail.com
Safe HaskellSafe-Inferred
LanguageHaskell2010

Servant.API.Routes.Param

Description

Simple representation of HTTP query params

Synopsis

Documentation

data Param Source #

Newtype wrapper around servant's Param so we can define a sensible Eq instance for it.

Instances

Instances details
ToJSON Param Source # 
Instance details

Defined in Servant.API.Routes.Param

Methods

toJSON :: Param -> Value Source #

toEncoding :: Param -> Encoding Source #

toJSONList :: [Param] -> Value Source #

toEncodingList :: [Param] -> Encoding Source #

Show Param Source # 
Instance details

Defined in Servant.API.Routes.Param

Methods

showsPrec :: Int -> Param -> ShowS Source #

show :: Param -> String Source #

showList :: [Param] -> ShowS Source #

Eq Param Source # 
Instance details

Defined in Servant.API.Routes.Param

Methods

(==) :: Param -> Param -> Bool Source #

(/=) :: Param -> Param -> Bool Source #

singleParam :: forall s a. (KnownSymbol s, Typeable a) => Param Source #

Create a SingleParam from a Symbol and a TypeRep via Typeable.

arrayElemParam :: forall s a. (KnownSymbol s, Typeable a) => Param Source #

Create an ArrayParam from a Symbol and a TypeRep via Typeable.

flagParam :: forall s. KnownSymbol s => Param Source #

Create a FlagParam from a Symbol.

renderParam :: Param -> Text Source #

Pretty-print a Param. Used by showRoute.