Idris2Doc : HTTP.API.Query

HTTP.API.Query

(source)

Definitions

data QField : Type
  Mathes a single key-value pair in the *query* part of
the request URI.

In general, key and value are assumed to be separated by an
equals sign ('='), which several key-value pairs are
separated by an ampersand ('&').

In addition to key-value pair, boolean queries are also supported,
where only the presence of the key is tested, and a value can be
optional.

Totality: total
Visibility: public export
Constructors:
(??) : ByteString -> (0 _ : Type) -> QField
QBool : ByteString -> QField
0 QueryTypes : List QField -> List Type
  Computes the list of types captured by a URI query description.

Totality: total
Visibility: public export
0 QueryConstraintTypes : List QField -> List Type
  Computes the list of types that need to be decoded from
a URI query part.

This is used to compute the constraints required to interpret a
query description.

This differs from `QueryTypes`, since boolean queries need not
be decoded.

Totality: total
Visibility: public export
record ReqQuery : Type
  Wraps a list of `QField`s to account for a full description
of values extracted from a URI query.

Totality: total
Visibility: public export
Constructor: 
Query : List QField -> ReqQuery

Projection: 
.fields : ReqQuery -> List QField
.fields : ReqQuery -> List QField
Totality: total
Visibility: public export
fields : ReqQuery -> List QField
Totality: total
Visibility: public export