Safe Haskell	None
Language	Haskell2010

Network.GRPC.Common.Binary

Contents

Encoding and decoding

Description

Binary RPC

Intended for unqualified import.

Synopsis

data RawRpc (serv :: Symbol) (meth :: Symbol)
encode :: Binary a => a -> ByteString
decodeOrThrow :: (MonadIO m, Binary a) => ByteString -> m a
data DecodeException = DecodeException {
- unconsumed :: ByteString
- consumed :: ByteOffset
- errorMessage :: String
}

Documentation

data RawRpc (serv :: Symbol) (meth :: Symbol) #

Instances

Instances details

(KnownSymbol serv, KnownSymbol meth, Show (RequestMetadata (RawRpc serv meth)), Show (ResponseInitialMetadata (RawRpc serv meth)), Show (ResponseTrailingMetadata (RawRpc serv meth))) => IsRPC (RawRpc serv meth :: Type)
Instance details Defined in Network.GRPC.Spec.RPC.Raw Methods rpcContentType :: Proxy (RawRpc serv meth) -> ByteString # rpcServiceName :: Proxy (RawRpc serv meth) -> ByteString # rpcMethodName :: Proxy (RawRpc serv meth) -> ByteString # rpcMessageType :: Proxy (RawRpc serv meth) -> Maybe ByteString #
(IsRPC (RawRpc serv meth), BuildMetadata (RequestMetadata (RawRpc serv meth)), ParseMetadata (ResponseInitialMetadata (RawRpc serv meth)), ParseMetadata (ResponseTrailingMetadata (RawRpc serv meth))) => SupportsClientRpc (RawRpc serv meth :: Type)
Instance details Defined in Network.GRPC.Spec.RPC.Raw Methods rpcSerializeInput :: Proxy (RawRpc serv meth) -> Input (RawRpc serv meth) -> ByteString # rpcDeserializeOutput :: Proxy (RawRpc serv meth) -> ByteString -> Either String (Output (RawRpc serv meth)) #
(IsRPC (RawRpc serv meth), ParseMetadata (RequestMetadata (RawRpc serv meth)), BuildMetadata (ResponseInitialMetadata (RawRpc serv meth)), StaticMetadata (ResponseTrailingMetadata (RawRpc serv meth))) => SupportsServerRpc (RawRpc serv meth :: Type)
Instance details Defined in Network.GRPC.Spec.RPC.Raw Methods rpcDeserializeInput :: Proxy (RawRpc serv meth) -> ByteString -> Either String (Input (RawRpc serv meth)) # rpcSerializeOutput :: Proxy (RawRpc serv meth) -> Output (RawRpc serv meth) -> ByteString #
ValidStreamingType styp => SupportsStreamingType (RawRpc serv meth :: Type) styp
Instance details Defined in Network.GRPC.Spec.RPC.Raw
type Input (RawRpc serv meth :: Type)
Instance details Defined in Network.GRPC.Spec.RPC.Raw type Input (RawRpc serv meth :: Type) = ByteString
type Output (RawRpc serv meth :: Type)
Instance details Defined in Network.GRPC.Spec.RPC.Raw type Output (RawRpc serv meth :: Type) = ByteString

Encoding and decoding

encode :: Binary a => a -> ByteString #

Encode a value using binary serialisation to a lazy ByteString.

decodeOrThrow :: (MonadIO m, Binary a) => ByteString -> m a Source #

data DecodeException Source #

Constructors

DecodeException
Fields unconsumed :: ByteString consumed :: ByteOffset errorMessage :: String

Instances

Instances details

Exception DecodeException Source #
Instance details Defined in Network.GRPC.Common.Binary Methods toException :: DecodeException -> SomeException # fromException :: SomeException -> Maybe DecodeException # displayException :: DecodeException -> String # backtraceDesired :: DecodeException -> Bool #
Show DecodeException Source #
Instance details Defined in Network.GRPC.Common.Binary Methods showsPrec :: Int -> DecodeException -> ShowS # show :: DecodeException -> String # showList :: [DecodeException] -> ShowS #