Data.Bond.Proto

Documentation

class BondProto t where

Typeclass for Bond serialization protocols.

Minimal complete definition

bondRead, bondWrite, bondReadWithSchema, bondWriteWithSchema, protoSig

Methods

bondRead :: BondStruct a => t -> ByteString -> Either String a

Deserialize structure from stream.

bondWrite :: BondStruct a => t -> a -> Either String ByteString

Serialize structure to stream.

bondReadWithSchema :: t -> StructSchema -> ByteString -> Either String Struct

Deserialize structure from stream using provided schema.

bondWriteWithSchema :: t -> StructSchema -> Struct -> Either String ByteString

Serialize structure to stream using provided schema.

bondMarshal :: BondStruct a => t -> a -> Either String ByteString

Serialize structure to stream and add protocol header. See bondUnmarshal for deserialization.

bondMarshalWithSchema :: t -> StructSchema -> Struct -> Either String ByteString

Serialize structure to stream using provided schema and add protocol header. See bondUnmarshalWithSchema for deserialization.

protoSig :: t -> ByteString

Get protocol header.

Instances

BondProto CompactBinaryV1Proto

Methods

bondRead :: BondStruct a => CompactBinaryV1Proto -> ByteString -> Either String a

bondWrite :: BondStruct a => CompactBinaryV1Proto -> a -> Either String ByteString

bondReadWithSchema :: CompactBinaryV1Proto -> StructSchema -> ByteString -> Either String Struct

bondWriteWithSchema :: CompactBinaryV1Proto -> StructSchema -> Struct -> Either String ByteString

bondMarshal :: BondStruct a => CompactBinaryV1Proto -> a -> Either String ByteString

bondMarshalWithSchema :: CompactBinaryV1Proto -> StructSchema -> Struct -> Either String ByteString

protoSig :: CompactBinaryV1Proto -> ByteString

BondProto CompactBinaryProto

Methods

bondRead :: BondStruct a => CompactBinaryProto -> ByteString -> Either String a

bondWrite :: BondStruct a => CompactBinaryProto -> a -> Either String ByteString

bondReadWithSchema :: CompactBinaryProto -> StructSchema -> ByteString -> Either String Struct

bondWriteWithSchema :: CompactBinaryProto -> StructSchema -> Struct -> Either String ByteString

bondMarshal :: BondStruct a => CompactBinaryProto -> a -> Either String ByteString

bondMarshalWithSchema :: CompactBinaryProto -> StructSchema -> Struct -> Either String ByteString

protoSig :: CompactBinaryProto -> ByteString

BondProto FastBinaryProto

Methods

bondRead :: BondStruct a => FastBinaryProto -> ByteString -> Either String a

bondWrite :: BondStruct a => FastBinaryProto -> a -> Either String ByteString

bondReadWithSchema :: FastBinaryProto -> StructSchema -> ByteString -> Either String Struct

bondWriteWithSchema :: FastBinaryProto -> StructSchema -> Struct -> Either String ByteString

bondMarshal :: BondStruct a => FastBinaryProto -> a -> Either String ByteString

bondMarshalWithSchema :: FastBinaryProto -> StructSchema -> Struct -> Either String ByteString

protoSig :: FastBinaryProto -> ByteString

BondProto JsonProto

Methods

bondRead :: BondStruct a => JsonProto -> ByteString -> Either String a

bondWrite :: BondStruct a => JsonProto -> a -> Either String ByteString

bondReadWithSchema :: JsonProto -> StructSchema -> ByteString -> Either String Struct

bondWriteWithSchema :: JsonProto -> StructSchema -> Struct -> Either String ByteString

bondMarshal :: BondStruct a => JsonProto -> a -> Either String ByteString

bondMarshalWithSchema :: JsonProto -> StructSchema -> Struct -> Either String ByteString

protoSig :: JsonProto -> ByteString

BondProto SimpleBinaryV1Proto

Methods

bondRead :: BondStruct a => SimpleBinaryV1Proto -> ByteString -> Either String a

bondWrite :: BondStruct a => SimpleBinaryV1Proto -> a -> Either String ByteString

bondReadWithSchema :: SimpleBinaryV1Proto -> StructSchema -> ByteString -> Either String Struct

bondWriteWithSchema :: SimpleBinaryV1Proto -> StructSchema -> Struct -> Either String ByteString

bondMarshal :: BondStruct a => SimpleBinaryV1Proto -> a -> Either String ByteString

bondMarshalWithSchema :: SimpleBinaryV1Proto -> StructSchema -> Struct -> Either String ByteString

protoSig :: SimpleBinaryV1Proto -> ByteString

BondProto SimpleBinaryProto

Methods

bondRead :: BondStruct a => SimpleBinaryProto -> ByteString -> Either String a

bondWrite :: BondStruct a => SimpleBinaryProto -> a -> Either String ByteString

bondReadWithSchema :: SimpleBinaryProto -> StructSchema -> ByteString -> Either String Struct

bondWriteWithSchema :: SimpleBinaryProto -> StructSchema -> Struct -> Either String ByteString

bondMarshal :: BondStruct a => SimpleBinaryProto -> a -> Either String ByteString

bondMarshalWithSchema :: SimpleBinaryProto -> StructSchema -> Struct -> Either String ByteString

protoSig :: SimpleBinaryProto -> ByteString

class BondProto t => BondTaggedProto t where

Typeclass for tagged Bond serialization protocols. Such protocols support schemaless operations.

Minimal complete definition

bondReadTagged, bondWriteTagged

Methods

bondReadTagged :: t -> ByteString -> Either String Struct

Deserialize structure from stream without schema.

bondWriteTagged :: t -> Struct -> Either String ByteString

Serialize structure to stream without schema.

bondMarshalTagged :: t -> Struct -> Either String ByteString

Serialize structure to stream without schema and add protocol header. See bondUnmarshalTagged for deserialization.

Instances

BondTaggedProto CompactBinaryV1Proto

Methods

bondReadTagged :: CompactBinaryV1Proto -> ByteString -> Either String Struct

bondWriteTagged :: CompactBinaryV1Proto -> Struct -> Either String ByteString

bondMarshalTagged :: CompactBinaryV1Proto -> Struct -> Either String ByteString

BondTaggedProto CompactBinaryProto

Methods

bondReadTagged :: CompactBinaryProto -> ByteString -> Either String Struct

bondWriteTagged :: CompactBinaryProto -> Struct -> Either String ByteString

bondMarshalTagged :: CompactBinaryProto -> Struct -> Either String ByteString

BondTaggedProto FastBinaryProto

Methods

bondReadTagged :: FastBinaryProto -> ByteString -> Either String Struct

bondWriteTagged :: FastBinaryProto -> Struct -> Either String ByteString

bondMarshalTagged :: FastBinaryProto -> Struct -> Either String ByteString