servant-routes
Copyright(c) Frederick Pringle 2025
LicenseBSD-3-Clause
Maintainerfrederick.pringle@fpringle.com
Safe HaskellNone
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.Internal.Param

Methods

toJSON :: Param -> Value #

toEncoding :: Param -> Encoding #

toJSONList :: [Param] -> Value #

toEncodingList :: [Param] -> Encoding #

omitField :: Param -> Bool #

Show Param Source # 
Instance details

Defined in Servant.API.Routes.Internal.Param

Methods

showsPrec :: Int -> Param -> ShowS #

show :: Param -> String #

showList :: [Param] -> ShowS #

Eq Param Source # 
Instance details

Defined in Servant.API.Routes.Internal.Param

Methods

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

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

Ord Param Source # 
Instance details

Defined in Servant.API.Routes.Internal.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 #

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

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

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

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

flagParam :: forall (s :: Symbol). KnownSymbol s => Param Source #

Create a FlagParam from a Symbol.

renderParam :: Param -> Text Source #

Pretty-print a Param. Used by renderRoute.