Pact.API.HttpApiData

Parse and convert URL pieces and headers.

Definitions

interface FromHttpApiData : Type -> Type

  Parse a URL piece or header into a value.

Parameters: a
Methods:

parseUrlPiece : String -> Either String a

  Parse a URL piece into a value.

parseHeader : String -> Either String a

  Parse a header into a value.

parseQueryParam : String -> Either String a

  Parse a query parameter into a value.

Implementations:

FromHttpApiData ()

FromHttpApiData Bool

FromHttpApiData Char

FromHttpApiData String

FromHttpApiData Nat

FromHttpApiData Int

FromHttpApiData Integer

FromHttpApiData Int8

FromHttpApiData Int16

FromHttpApiData Int32

FromHttpApiData Int64

FromHttpApiData Bits8

FromHttpApiData Bits16

FromHttpApiData Bits32

FromHttpApiData Bits64

FromHttpApiData Double

FromHttpApiData a => FromHttpApiData (Maybe a)

Monoid a => FromHttpApiData b => FromHttpApiData (Either a b)

FromHttpApiData a => FromHttpApiData (List1 a)

FromHttpApiData a => FromHttpApiData (List a)

FromHttpApiData a => FromHttpApiData (n : Nat ** Vect n a)

parseUrlPiece : FromHttpApiData a => String -> Either String a

  Parse a URL piece into a value.

Visibility: public export

parseHeader : FromHttpApiData a => String -> Either String a

  Parse a header into a value.

Visibility: public export

parseQueryParam : FromHttpApiData a => String -> Either String a

  Parse a query parameter into a value.

Visibility: public export

interface ToHttpApiData : Type -> Type

  Convert a value to a URL piece or header.

Parameters: a
Methods:

toUrlPiece : a -> String

  Convert a value to a URL piece.

toHeader : a -> String

  Convert a value to a header.

toQueryParam : a -> String

  Convert a value to a query parameter.

Implementations:

ToHttpApiData String

ToHttpApiData ()

ToHttpApiData Bool

ToHttpApiData Char

ToHttpApiData Nat

ToHttpApiData Int

ToHttpApiData Integer

ToHttpApiData Int8

ToHttpApiData Int16

ToHttpApiData Int32

ToHttpApiData Int64

ToHttpApiData Bits8

ToHttpApiData Bits16

ToHttpApiData Bits32

ToHttpApiData Bits64

ToHttpApiData Double

ToHttpApiData a => ToHttpApiData (Maybe a)

ToHttpApiData a => ToHttpApiData (Either a b)

ToHttpApiData a => ToHttpApiData (List a)

ToHttpApiData a => ToHttpApiData (List1 a)

ToHttpApiData a => ToHttpApiData (n : Nat ** Vect n a)

toUrlPiece : ToHttpApiData a => a -> String

  Convert a value to a URL piece.

Visibility: public export

toHeader : ToHttpApiData a => a -> String

  Convert a value to a header.

Visibility: public export

toQueryParam : ToHttpApiData a => a -> String

  Convert a value to a query parameter.

Visibility: public export