Copyright	(c) Abhinav Gupta 2015
License	BSD3
Maintainer	Abhinav Gupta <mail@abhinavg.net>
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Pinch.Protocol

Description

Protocols in Pinch only need to know how to serialize and deserialize Value objects. Types that want to be serialized into/from Thrift payloads define how to convert them to/from Value objects via Pinchable.

Synopsis

data Protocol = Protocol {
- serializeValue :: forall a. IsTType a => Value a -> Builder
- serializeMessage :: Message -> Builder
- deserializeValue' :: forall a. IsTType a => Get (Value a)
- deserializeMessage' :: Get Message
}
deserializeValue :: forall a. IsTType a => Protocol -> ByteString -> Either String (Value a)
deserializeMessage :: Protocol -> ByteString -> Either String Message

Documentation

data Protocol Source #

Protocols define a specific way to convert values into binary and back.

Constructors

Protocol

Fields

serializeValue :: forall a. IsTType a => Value a -> Builder
Serializes a Value into a ByteString builder.
Returns a Builder and the total length of the serialized content.
serializeMessage :: Message -> Builder
Serializes a Message and its payload into a ByteString builder.
Returns a Builder and the total length of the serialized content.
deserializeValue' :: forall a. IsTType a => Get (Value a)
Reads a Value from a ByteString and returns leftovers from parse.
deserializeMessage' :: Get Message
Reads a Message and its payload.

deserializeValue :: forall a. IsTType a => Protocol -> ByteString -> Either String (Value a) Source #

Reads a Value from a ByteString.

deserializeMessage :: Protocol -> ByteString -> Either String Message Source #

Reads a Message and its payload from a ByteString.