Safe Haskell	Safe
Language	Haskell2010

Network.GRPC.HTTP2.Encoding

Contents

Encoding and decoding.
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

class IsRPC r => GRPCInput r i where
- encodeInput :: r -> Compression -> i -> Builder
- decodeInput :: r -> Compression -> Decoder (Either String i)
class IsRPC r => GRPCOutput r o where
- encodeOutput :: r -> Compression -> o -> Builder
- decodeOutput :: r -> Compression -> Decoder (Either String o)
data Builder
data Decoder a
fromBuilder :: Builder -> ByteString
fromDecoder :: Decoder (Either String a) -> Either String a
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

Encoding and decoding.

class IsRPC r => GRPCInput r i where Source #

Methods

encodeInput :: r -> Compression -> i -> Builder Source #

decodeInput :: r -> Compression -> Decoder (Either String i) Source #

class IsRPC r => GRPCOutput r o where Source #

Methods

encodeOutput :: r -> Compression -> o -> Builder Source #

decodeOutput :: r -> Compression -> Decoder (Either String o) Source #

data Builder #

Builders denote sequences of bytes. They are Monoids where mempty is the zero-length sequence and mappend is concatenation, which runs in O(1).

Instances

Semigroup Builder
Instance details Defined in Data.ByteString.Builder.Internal Methods (<>) :: Builder -> Builder -> Builder # sconcat :: NonEmpty Builder -> Builder # stimes :: Integral b => b -> Builder -> Builder #
Monoid Builder
Instance details Defined in Data.ByteString.Builder.Internal Methods mempty :: Builder # mappend :: Builder -> Builder -> Builder # mconcat :: [Builder] -> Builder #

data Decoder a #

A decoder procuced by running a Get monad.

fromBuilder :: Builder -> ByteString Source #

Finalizes a Builder.

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

Tries finalizing a Decoder.

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.