Data.ProtoLens.Encoding

Functions for encoding and decoding protocol buffer Messages.

TODO: Currently all operations are on strict ByteStrings; we should try to generalize to lazy Bytestrings as well.

Documentation

encodeMessage :: Message msg => msg -> ByteString

Encode a message to the wire format.

buildMessage :: Message msg => msg -> Builder

Encode a message to the wire format, as part of a Builder.

decodeMessage :: Message msg => ByteString -> Either String msg

Decode a message from its wire format. Returns Left if the decoding fails.

decodeMessageOrDie :: Message msg => ByteString -> msg

Decode a message from its wire format. Throws an error if the decoding fails.