Capnp.Convert

This module provides various helper functions to convert between messages, types defined in capnproto schema (called "values" in the rest of this module's documentation), bytestrings (both lazy and strict), and bytestring builders.

Note that most of the functions which decode messages or raw bytes do *not* need to be run inside of an instance of MonadLimit; they choose an appropriate limit based on the size of the input.

Note that not all conversions exist or necessarily make sense.

Documentation

msgToBuilder :: Message 'Const -> Builder

Convert an immutable message to a bytestring Builder. To convert a mutable message, freeze it first.

msgToLBS :: Message 'Const -> ByteString

Convert an immutable message to a lazy ByteString. To convert a mutable message, freeze it first.

msgToBS :: Message 'Const -> ByteString

Convert an immutable message to a strict ByteString. To convert a mutable message, freeze it first.

msgToValue :: (MonadThrow m, MonadReadMessage mut (LimitT m), MonadReadMessage mut m, FromStruct mut a) => Message mut -> m a

Convert a message to a value.

bsToMsg :: MonadThrow m => ByteString -> m (Message 'Const)

Convert a strict ByteString to a message.

bsToValue :: (MonadThrow m, FromStruct 'Const a) => ByteString -> m a

Convert a strict ByteString to a value.

lbsToMsg :: MonadThrow m => ByteString -> m (Message 'Const)

Convert a lazy ByteString to a message.

lbsToValue :: (MonadThrow m, FromStruct 'Const a) => ByteString -> m a

Convert a lazy ByteString to a value.

valueToBuilder :: (MonadLimit m, WriteCtx m s, Cerialize s a, ToStruct ('Mut s) (Cerial ('Mut s) a)) => a -> m Builder

Convert a value to a Builder.

valueToBS :: (MonadLimit m, WriteCtx m s, Cerialize s a, ToStruct ('Mut s) (Cerial ('Mut s) a)) => a -> m ByteString

Convert a value to a strict ByteString.

valueToLBS :: (MonadLimit m, WriteCtx m s, Cerialize s a, ToStruct ('Mut s) (Cerial ('Mut s) a)) => a -> m ByteString

Convert a value to a lazy ByteString.

valueToMsg :: (MonadLimit m, WriteCtx m s, Cerialize s a, ToStruct ('Mut s) (Cerial ('Mut s) a)) => a -> m (Message ('Mut s))

Convert a value to a message.

msgToRaw :: forall a m mut. (ReadCtx m mut, IsStruct a) => Message mut -> m (Raw mut a)

Get the root pointer of a message, wrapped as a Raw.

msgToParsed :: forall a m pa. (ReadCtx m 'Const, IsStruct a, Parse a pa) => Message 'Const -> m pa

Get the root pointer of a message, as a parsed ADT.

bsToRaw :: (ReadCtx m 'Const, IsStruct a) => ByteString -> m (Raw 'Const a)

Like msgToRaw, but takes a (strict) bytestring.

bsToParsed :: (ReadCtx m 'Const, IsStruct a, Parse a pa) => ByteString -> m pa

Like msgToParsed, but takes a (strict) bytestring.

lbsToRaw :: (ReadCtx m 'Const, IsStruct a) => ByteString -> m (Raw 'Const a)

Like msgToRaw, but takes a (lazy) bytestring.

lbsToParsed :: (ReadCtx m 'Const, IsStruct a, Parse a pa) => ByteString -> m pa

Like msgToParsed, but takes a (lazzy) bytestring.

parsedToRaw :: forall a m pa s. (RWCtx m s, IsStruct a, Parse a pa) => pa -> m (Raw ('Mut s) a)

Serialize the parsed form of a struct into its Raw form, and make it the root of its message.

parsedToMsg :: forall a m pa s. (RWCtx m s, IsStruct a, Parse a pa) => pa -> m (Message ('Mut s))

Serialize the parsed form of a struct into a message with that value as its root, returning the message.

parsedToBuilder :: forall a m pa s. (RWCtx m s, IsStruct a, Parse a pa) => pa -> m Builder

Serialize the parsed form of a struct and return it as a Builder

parsedToBS :: forall a m pa s. (RWCtx m s, IsStruct a, Parse a pa) => pa -> m ByteString

Serialize the parsed form of a struct and return it as a strict ByteString

parsedToLBS :: forall a m pa s. (RWCtx m s, IsStruct a, Parse a pa) => pa -> m ByteString

Serialize the parsed form of a struct and return it as a lazy ByteString