HTTP.API.Encode

Reexports

Definitions

interface Encode : Type -> Type

  An interface for encode a value as raw bytes
  
  This is used for encoding values in URL paths and query strings
  but - in general - not for encoding value in the message body.
  Use `EncodeVia` for that.

Parameters: a
Methods:

encode : a -> ByteString

Implementations:

Encode ByteString

Encode String

Encode Nat

Encode Integer

Encode Bits8

Encode Bits16

Encode Bits32

Encode Bits64

Encode Int8

Encode Int16

Encode Int32

Encode Int64

Encode Double

encode : Encode a => a -> ByteString

Totality: total
Visibility: public export

interface EncodeMany : Type -> Type

  An interface for encoding values as a list of bytestrings.

Parameters: a
Methods:

encodeMany : a -> List ByteString

Implementations:

Encode a => EncodeMany a

All (EncodeMany . f) ts => EncodeMany (All f ts)

EncodeMany a => EncodeMany (Vect n a)

EncodeMany a => EncodeMany (List a)

EncodeMany a => EncodeMany (SnocList a)

encodeMany : EncodeMany a => a -> List ByteString

Totality: total
Visibility: public export

0 Text : Type

Totality: total
Visibility: public export

0 Octett : Type

Totality: total
Visibility: public export

0 OctettList : Type

Totality: total
Visibility: public export

interface EncodeVia : Type -> Type -> Type

Parameters: from, to
Methods:

encodeAs : from -> to

toBytes : to -> List ByteString

mediaType : MediaType

Implementations:

Interpolation a => EncodeVia a String

Cast a ByteString => EncodeVia a ByteString

Cast a (List ByteString) => EncodeVia a (List ByteString)

ToJSON a => EncodeVia a JSON

encodeAs : EncodeVia from to => from -> to

Totality: total
Visibility: public export

toBytes : EncodeVia from to => to -> List ByteString

Totality: total
Visibility: public export

mediaType : EncodeVia from to => MediaType

Totality: total
Visibility: public export

encodeVia : f -> EncodeVia f t -> List ByteString

Totality: total
Visibility: export