Arg package:servant-foreign

data Arg ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
Maps a name to the foreign type that belongs to the annotated value. Used for header args, query args, and capture args.
Arg :: PathSegment -> ftype -> Arg ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
data ArgType
servant-foreign Servant.Foreign Servant.Foreign.Internal
Type of a QueryArg.
argName :: forall ftype_adK6 . Lens' (Arg ftype_adK6) PathSegment
servant-foreign Servant.Foreign Servant.Foreign.Internal
argPath :: Getter (Arg ftype) Text
servant-foreign Servant.Foreign Servant.Foreign.Internal
argType :: forall ftype_adK6 ftype_adSZ . Lens (Arg ftype_adK6) (Arg ftype_adSZ) ftype_adK6 ftype_adSZ
servant-foreign Servant.Foreign Servant.Foreign.Internal
data HeaderArg ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
HeaderArg :: Arg ftype -> HeaderArg ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
The name of the header and the foreign type of its value.
data QueryArg ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
Url Query argument. Urls can contain query arguments, which is a list of key-value pairs. In a typical url, query arguments look like this: 
?foo=bar&alist[]=el1&alist[]=el2&aflag
Each pair can be
  • ?foo=bar: a plain key-val pair, either optional or required (QueryParam)
  • ?aflag: a flag (no value, implicitly Bool with default false if it’s missing) (QueryFlag)
  • ?alist[]=el1&alist[]=el2: list of values (QueryParams)
_queryArgType will be set accordingly. For the plain key-val pairs (QueryParam), _queryArgName’s ftype will be wrapped in a Maybe if the argument is optional.
QueryArg :: Arg ftype -> ArgType -> QueryArg ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
ReplaceHeaderArg :: Arg ftype -> Text -> HeaderArg ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
Unused, will never be set. TODO: remove
_HeaderArg :: forall ftype_aeJz . Prism' (HeaderArg ftype_aeJz) (Arg ftype_aeJz)
servant-foreign Servant.Foreign Servant.Foreign.Internal
_ReplaceHeaderArg :: forall ftype_aeJz . Prism' (HeaderArg ftype_aeJz) (Arg ftype_aeJz, Text)
servant-foreign Servant.Foreign Servant.Foreign.Internal
_argName :: Arg ftype -> PathSegment
servant-foreign Servant.Foreign Servant.Foreign.Internal
The name to be captured. Only for capture args it really denotes a path segment.
_argType :: Arg ftype -> ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
Foreign type the associated value will have
_headerArg :: HeaderArg ftype -> Arg ftype
servant-foreign Servant.Foreign Servant.Foreign Servant.Foreign.Internal Servant.Foreign.Internal
_queryArgName :: QueryArg ftype -> Arg ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
Name and foreign type of the argument. Will be wrapped in Maybe if the query is optional and in a `[]` if the query is a list
_queryArgType :: QueryArg ftype -> ArgType
servant-foreign Servant.Foreign Servant.Foreign.Internal
one of normal/plain, list or flag
captureArg :: Segment ftype -> Arg ftype
servant-foreign Servant.Foreign Servant.Foreign.Internal
Crashing Arg extraction from segment, TODO: remove
headerArg :: forall ftype_aeJz ftype_aeUx . Lens (HeaderArg ftype_aeJz) (HeaderArg ftype_aeUx) (Arg ftype_aeJz) (Arg ftype_aeUx)
servant-foreign Servant.Foreign Servant.Foreign.Internal
queryArgName :: forall ftype_aesx ftype_aeJj . Lens (QueryArg ftype_aesx) (QueryArg ftype_aeJj) (Arg ftype_aesx) (Arg ftype_aeJj)
servant-foreign Servant.Foreign Servant.Foreign.Internal
queryArgType :: forall ftype_aesx . Lens' (QueryArg ftype_aesx) ArgType
servant-foreign Servant.Foreign Servant.Foreign.Internal