http2-grpc-types-0.2.0.0: Types for gRPC over HTTP2 common for client and servers.

Safe Haskell	None
Language	Haskell2010

Network.GRPC.HTTP2.Encoding

Contents

Decoding.
Encoding.
Compression.

Description

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.

Synopsis

decoder :: Message a => Compression -> Decoder (Either String a)
fromDecoder :: Decoder (Either String a) -> Either String a
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))
encode :: Message m => Compression -> m -> Builder
fromBuilder :: Builder -> ByteString
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
data Compression = Compression {
- _compressionName :: ByteString
- _compressionByteSet :: Bool
- _compressionFunction :: ByteString -> ByteString
- _decompressionFunction :: ByteString -> Get ByteString
}
newtype Encoding = Encoding {
- _getEncodingCompression :: Compression
}
newtype Decoding = Decoding {
- _getDecodingCompression :: Compression
}
grpcCompressionHV :: Compression -> HeaderValue
uncompressed :: Compression
gzip :: Compression

Decoding.

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

Decoder for gRPC/HTTP2-encoded Protobuf messages.

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

Tries finalizing a Decoder.

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

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

Encoding.

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

Encodes as binary using gRPC/HTTP2 framing.

fromBuilder :: Builder -> ByteString Source #

Finalizes a Builder.

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

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

Compression.

data Compression Source #

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 Source #

Compression for Encoding.

Constructors

Encoding
Fields _getEncodingCompression :: Compression

newtype Decoding Source #

Compression for Decoding.

Constructors

Decoding
Fields _getDecodingCompression :: Compression

grpcCompressionHV :: Compression -> HeaderValue Source #

uncompressed :: Compression Source #

Do not compress.

gzip :: Compression Source #

Use gzip as compression.