Network.GRPC.HTTP2.Encoding

Module for GRPC binary encoding/decoding from and to binary messages.

So far, only "pure" compression algorithms are supported as we rely on Decoder (resp. Builder) which run with no interleaved side-effects.

Decoding.

decoder :: Message a => Compression -> Decoder (Either String a)

Decoder for gRPC/HTTP2-encoded Protobuf messages.

fromDecoder :: Decoder (Either String a) -> Either String a

Tries finalizing a Decoder.

decodeInput :: (Service s, HasMethod s m) => RPC s m -> Compression -> Decoder (Either String (MethodInput s m))

decodeOutput :: (Service s, HasMethod s m) => RPC s m -> Compression -> Decoder (Either String (MethodOutput s m))

Encoding.

encode :: Message m => Compression -> m -> Builder

Encodes as binary using gRPC/HTTP2 framing.

fromBuilder :: Builder -> ByteString

Finalizes a Builder.

encodeInput :: (Service s, HasMethod s m) => RPC s m -> Compression -> MethodInput s m -> Builder

encodeOutput :: (Service s, HasMethod s m) => RPC s m -> Compression -> MethodOutput s m -> Builder

Compression.

data Compression

Opaque type for handling compression.

So far, only "pure" compression algorithms are supported. TODO: suport IO-based compression implementations once we move from Builder.

Constructors

Compression

Fields

• _compressionName :: ByteString
• _compressionByteSet :: Bool
• _compressionFunction :: ByteString -> ByteString
• _decompressionFunction :: ByteString -> Get ByteString

newtype Encoding

Compression for Encoding.

Constructors

Encoding

Fields

• _getEncodingCompression :: Compression

newtype Decoding

Compression for Decoding.

Constructors

Decoding

Fields

• _getDecodingCompression :: Compression

grpcCompressionHV :: Compression -> HeaderValue

uncompressed :: Compression

Do not compress.

gzip :: Compression

Use gzip as compression.