Data.Capnp.Message

This module provides support for working directly with Cap'N Proto messages.

Reading and writing messages

hPutMsg :: Handle -> ConstMsg -> IO ()

hPutMsg handle msg writes msg to handle. If there is an exception, it will be an IOError raised by the underlying IO libraries.

hGetMsg :: Handle -> Int -> IO ConstMsg

hGetMsg handle limit reads a message from handle that is at most limit 64-bit words in length.

putMsg :: ConstMsg -> IO ()

Equivalent to hPutMsg stdout

getMsg :: Int -> IO ConstMsg

Equivalent to hGetMsg stdin

Limits on message size

maxSegmentSize :: Int

The maximum size of a segment supported by this libarary, in words.

maxSegments :: Int

The maximum number of segments allowed in a message by this library.

Converting between messages and ByteStrings

encode :: Monad m => ConstMsg -> m Builder

encode encodes a message as a bytestring builder.

decode :: MonadThrow m => ByteString -> m ConstMsg

decode decodes a message from a bytestring.

The segments will not be copied; the resulting message will be a view into the original bytestring. Runs in O(number of segments in the message).

Message type class

class Monad m => Message m msg where

A Message is a (possibly read-only) capnproto message. It is parameterized over a monad in which operations are performed.

Minimal complete definition

numSegs, internalGetSeg, numWords, slice, read, fromByteString, toByteString

Associated Types

data Segment msg

The type of segments in the message.

Methods

numSegs :: msg -> m Int

numSegs gets the number of segments in a message.

internalGetSeg :: msg -> Int -> m (Segment msg)

internalGetSeg message index gets the segment at index index in message. Most callers should use the getSegment wrapper, instead of calling this directly.

numWords :: Segment msg -> m Int

Get the length of the segment, in units of 64-bit words.

slice :: Int -> Int -> Segment msg -> m (Segment msg)

slice start length segment extracts a sub-section of the segment, starting at index start, of length length.

read :: Segment msg -> Int -> m Word64

read segment index reads a 64-bit word from the segement at the given index. Consider using getWord on the message, instead of calling this directly.

fromByteString :: ByteString -> m (Segment msg)

Convert a ByteString to a segment.

toByteString :: Segment msg -> m ByteString

Convert a segment to a byte string.

Instances

Monad m => Message m ConstMsg

Defined in Data.Capnp.Message

Associated Types

data Segment ConstMsg :: *

Methods

numSegs :: ConstMsg -> m Int

internalGetSeg :: ConstMsg -> Int -> m (Segment ConstMsg)

numWords :: Segment ConstMsg -> m Int

slice :: Int -> Int -> Segment ConstMsg -> m (Segment ConstMsg)

read :: Segment ConstMsg -> Int -> m Word64

fromByteString :: ByteString -> m (Segment ConstMsg)

toByteString :: Segment ConstMsg -> m ByteString

(PrimMonad m, s ~ PrimState m) => Message m (MutMsg s)

Defined in Data.Capnp.Message

Associated Types

data Segment (MutMsg s) :: *

Methods

numSegs :: MutMsg s -> m Int

internalGetSeg :: MutMsg s -> Int -> m (Segment (MutMsg s))

numWords :: Segment (MutMsg s) -> m Int

slice :: Int -> Int -> Segment (MutMsg s) -> m (Segment (MutMsg s))

read :: Segment (MutMsg s) -> Int -> m Word64

fromByteString :: ByteString -> m (Segment (MutMsg s))

toByteString :: Segment (MutMsg s) -> m ByteString

Immutable messages

empty :: ConstMsg

empty is an empty message, i.e. a minimal message with a null pointer as its root object.

data ConstMsg

A read-only capnproto message.

ConstMsg is an instance of the generic Message type class. its implementations of toByteString and fromByteString are O(1); the underlying bytes are not copied.

Instances

Thaw ConstMsg

Defined in Data.Capnp.Message

Associated Types

type Mutable s ConstMsg :: *

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => ConstMsg -> m (Mutable s ConstMsg)

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s ConstMsg -> m ConstMsg

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => ConstMsg -> m (Mutable s ConstMsg)

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s ConstMsg -> m ConstMsg

Monad m => Message m ConstMsg

Defined in Data.Capnp.Message

Associated Types

data Segment ConstMsg :: *

Methods

numSegs :: ConstMsg -> m Int

internalGetSeg :: ConstMsg -> Int -> m (Segment ConstMsg)

numWords :: Segment ConstMsg -> m Int

slice :: Int -> Int -> Segment ConstMsg -> m (Segment ConstMsg)

read :: Segment ConstMsg -> Int -> m Word64

fromByteString :: ByteString -> m (Segment ConstMsg)

toByteString :: Segment ConstMsg -> m ByteString

FromStruct ConstMsg Type'anyPointer'unconstrained

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Type'anyPointer'unconstrained

FromStruct ConstMsg Type'anyPointer

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Type'anyPointer

FromStruct ConstMsg Node'Parameter

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Node'Parameter

FromStruct ConstMsg Node'NestedNode

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Node'NestedNode

FromStruct ConstMsg Node'

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Node'

FromStruct ConstMsg Field'ordinal

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Field'ordinal

FromStruct ConstMsg Field'

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Field'

FromStruct ConstMsg CodeGeneratorRequest'RequestedFile'Import

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m CodeGeneratorRequest'RequestedFile'Import

FromStruct ConstMsg CodeGeneratorRequest'RequestedFile

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m CodeGeneratorRequest'RequestedFile

FromStruct ConstMsg Brand'Scope'

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Brand'Scope'

FromStruct ConstMsg Brand'Scope

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Brand'Scope

FromStruct ConstMsg Brand'Binding

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Brand'Binding

FromStruct ConstMsg Value

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Value

FromStruct ConstMsg Type

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Type

FromStruct ConstMsg Superclass

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Superclass

FromStruct ConstMsg Node

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Node

FromStruct ConstMsg Method

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Method

FromStruct ConstMsg Field

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Field

FromStruct ConstMsg Enumerant

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Enumerant

FromStruct ConstMsg CodeGeneratorRequest

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m CodeGeneratorRequest

FromStruct ConstMsg CapnpVersion

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m CapnpVersion

FromStruct ConstMsg Brand

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Brand

FromStruct ConstMsg Annotation

Defined in Capnp.Capnp.Schema.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Annotation

FromStruct ConstMsg VatId

Defined in Capnp.Capnp.RpcTwoparty.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m VatId

FromStruct ConstMsg ProvisionId

Defined in Capnp.Capnp.RpcTwoparty.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m ProvisionId

FromStruct ConstMsg JoinResult

Defined in Capnp.Capnp.RpcTwoparty.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m JoinResult

FromStruct ConstMsg JoinKeyPart

Defined in Capnp.Capnp.RpcTwoparty.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m JoinKeyPart

FromStruct ConstMsg Return'

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Return'

FromStruct ConstMsg Resolve'

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Resolve'

FromStruct ConstMsg PromisedAnswer'Op

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m PromisedAnswer'Op

FromStruct ConstMsg Disembargo'context

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Disembargo'context

FromStruct ConstMsg Call'sendResultsTo

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Call'sendResultsTo

FromStruct ConstMsg ThirdPartyCapDescriptor

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m ThirdPartyCapDescriptor

FromStruct ConstMsg Return

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Return

FromStruct ConstMsg Resolve

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Resolve

FromStruct ConstMsg Release

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Release

FromStruct ConstMsg Provide

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Provide

FromStruct ConstMsg PromisedAnswer

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m PromisedAnswer

FromStruct ConstMsg Payload

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Payload

FromStruct ConstMsg MessageTarget

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m MessageTarget

FromStruct ConstMsg Message

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Message

FromStruct ConstMsg Join

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Join

FromStruct ConstMsg Finish

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Finish

FromStruct ConstMsg Exception

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Exception

FromStruct ConstMsg Disembargo

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Disembargo

FromStruct ConstMsg CapDescriptor

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m CapDescriptor

FromStruct ConstMsg Call

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Call

FromStruct ConstMsg Bootstrap

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Bootstrap

FromStruct ConstMsg Accept

Defined in Capnp.Capnp.Rpc.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Accept

FromStruct ConstMsg Persistent'SaveResults

Defined in Capnp.Capnp.Persistent.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Persistent'SaveResults

FromStruct ConstMsg Persistent'SaveParams

Defined in Capnp.Capnp.Persistent.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m Persistent'SaveParams

FromStruct ConstMsg JsonValue'Field

Defined in Capnp.Capnp.Json.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m JsonValue'Field

FromStruct ConstMsg JsonValue'Call

Defined in Capnp.Capnp.Json.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m JsonValue'Call

FromStruct ConstMsg JsonValue

Defined in Capnp.Capnp.Json.Pure

Methods

fromStruct :: ReadCtx m ConstMsg => Struct ConstMsg -> m JsonValue

Thaw (Segment ConstMsg)

Defined in Data.Capnp.Message

Associated Types

type Mutable s (Segment ConstMsg) :: *

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => Segment ConstMsg -> m (Mutable s (Segment ConstMsg))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (Segment ConstMsg) -> m (Segment ConstMsg)

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => Segment ConstMsg -> m (Mutable s (Segment ConstMsg))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (Segment ConstMsg) -> m (Segment ConstMsg)

data Segment ConstMsg

Defined in Data.Capnp.Message

data Segment ConstMsg = ConstSegment {

• constSegToVec :: Vector Word64

}

type Mutable s ConstMsg

Defined in Data.Capnp.Message

type Mutable s ConstMsg = MutMsg s

type Mutable s (Segment ConstMsg)

Defined in Data.Capnp.Message

type Mutable s (Segment ConstMsg) = Segment (MutMsg s)

Reading data from messages

getSegment :: (MonadThrow m, Message m msg) => msg -> Int -> m (Segment msg)

getSegment message index fetches the given segment in the message. It throws a BoundsError if the address is out of bounds.

getWord :: (MonadThrow m, Message m msg) => msg -> WordAddr -> m Word64

getWord msg addr returns the word at addr within msg. It throws a BoundsError if the address is out of bounds.

Mutable Messages

data MutMsg s

A MutMsg is a mutable capnproto message. The type parameter s is the state token for the instance of PrimMonad in which the message may be modified.

Due to mutabilty, the implementations of toByteString and fromByteString must make full copies, and so are O(n) in the length of the segment.

Instances

(PrimMonad m, s ~ PrimState m) => Message m (MutMsg s)

Defined in Data.Capnp.Message

Associated Types

data Segment (MutMsg s) :: *

Methods

numSegs :: MutMsg s -> m Int

internalGetSeg :: MutMsg s -> Int -> m (Segment (MutMsg s))

numWords :: Segment (MutMsg s) -> m Int

slice :: Int -> Int -> Segment (MutMsg s) -> m (Segment (MutMsg s))

read :: Segment (MutMsg s) -> Int -> m Word64

fromByteString :: ByteString -> m (Segment (MutMsg s))

toByteString :: Segment (MutMsg s) -> m ByteString

Allocate s (Node'Parameter (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Node'Parameter (MutMsg s))

Allocate s (Node'NestedNode (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Node'NestedNode (MutMsg s))

Allocate s (Node' (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Node' (MutMsg s))

Allocate s (Field' (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Field' (MutMsg s))

Allocate s (CodeGeneratorRequest'RequestedFile'Import (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (CodeGeneratorRequest'RequestedFile'Import (MutMsg s))

Allocate s (CodeGeneratorRequest'RequestedFile (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (CodeGeneratorRequest'RequestedFile (MutMsg s))

Allocate s (Brand'Scope' (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Brand'Scope' (MutMsg s))

Allocate s (Brand'Scope (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Brand'Scope (MutMsg s))

Allocate s (Brand'Binding (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Brand'Binding (MutMsg s))

Allocate s (Value (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Value (MutMsg s))

Allocate s (Type (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Type (MutMsg s))

Allocate s (Superclass (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Superclass (MutMsg s))

Allocate s (Node (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Node (MutMsg s))

Allocate s (Method (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Method (MutMsg s))

Allocate s (Field (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Field (MutMsg s))

Allocate s (Enumerant (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Enumerant (MutMsg s))

Allocate s (CodeGeneratorRequest (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (CodeGeneratorRequest (MutMsg s))

Allocate s (CapnpVersion (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (CapnpVersion (MutMsg s))

Allocate s (Brand (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Brand (MutMsg s))

Allocate s (Annotation (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

new :: WriteCtx m s => MutMsg s -> m (Annotation (MutMsg s))

Allocate s (VatId (MutMsg s))

Defined in Capnp.Capnp.RpcTwoparty

Methods

new :: WriteCtx m s => MutMsg s -> m (VatId (MutMsg s))

Allocate s (ProvisionId (MutMsg s))

Defined in Capnp.Capnp.RpcTwoparty

Methods

new :: WriteCtx m s => MutMsg s -> m (ProvisionId (MutMsg s))

Allocate s (JoinResult (MutMsg s))

Defined in Capnp.Capnp.RpcTwoparty

Methods

new :: WriteCtx m s => MutMsg s -> m (JoinResult (MutMsg s))

Allocate s (JoinKeyPart (MutMsg s))

Defined in Capnp.Capnp.RpcTwoparty

Methods

new :: WriteCtx m s => MutMsg s -> m (JoinKeyPart (MutMsg s))

Allocate s (Return' (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Return' (MutMsg s))

Allocate s (Resolve' (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Resolve' (MutMsg s))

Allocate s (PromisedAnswer'Op (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (PromisedAnswer'Op (MutMsg s))

Allocate s (ThirdPartyCapDescriptor (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (ThirdPartyCapDescriptor (MutMsg s))

Allocate s (Return (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Return (MutMsg s))

Allocate s (Resolve (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Resolve (MutMsg s))

Allocate s (Release (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Release (MutMsg s))

Allocate s (Provide (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Provide (MutMsg s))

Allocate s (PromisedAnswer (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (PromisedAnswer (MutMsg s))

Allocate s (Payload (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Payload (MutMsg s))

Allocate s (MessageTarget (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (MessageTarget (MutMsg s))

Allocate s (Message (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Message (MutMsg s))

Allocate s (Join (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Join (MutMsg s))

Allocate s (Finish (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Finish (MutMsg s))

Allocate s (Exception (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Exception (MutMsg s))

Allocate s (Disembargo (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Disembargo (MutMsg s))

Allocate s (CapDescriptor (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (CapDescriptor (MutMsg s))

Allocate s (Call (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Call (MutMsg s))

Allocate s (Bootstrap (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Bootstrap (MutMsg s))

Allocate s (Accept (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

new :: WriteCtx m s => MutMsg s -> m (Accept (MutMsg s))

Allocate s (Persistent'SaveResults (MutMsg s))

Defined in Capnp.Capnp.Persistent

Methods

new :: WriteCtx m s => MutMsg s -> m (Persistent'SaveResults (MutMsg s))

Allocate s (Persistent'SaveParams (MutMsg s))

Defined in Capnp.Capnp.Persistent

Methods

new :: WriteCtx m s => MutMsg s -> m (Persistent'SaveParams (MutMsg s))

Allocate s (JsonValue'Field (MutMsg s))

Defined in Capnp.Capnp.Json

Methods

new :: WriteCtx m s => MutMsg s -> m (JsonValue'Field (MutMsg s))

Allocate s (JsonValue'Call (MutMsg s))

Defined in Capnp.Capnp.Json

Methods

new :: WriteCtx m s => MutMsg s -> m (JsonValue'Call (MutMsg s))

Allocate s (JsonValue (MutMsg s))

Defined in Capnp.Capnp.Json

Methods

new :: WriteCtx m s => MutMsg s -> m (JsonValue (MutMsg s))

MutListElem s (Node'Parameter (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Node'Parameter (MutMsg s) -> Int -> List (MutMsg s) (Node'Parameter (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Node'Parameter (MutMsg s)))

MutListElem s (Node'NestedNode (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Node'NestedNode (MutMsg s) -> Int -> List (MutMsg s) (Node'NestedNode (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Node'NestedNode (MutMsg s)))

MutListElem s (Node' (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Node' (MutMsg s) -> Int -> List (MutMsg s) (Node' (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Node' (MutMsg s)))

MutListElem s (Field' (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Field' (MutMsg s) -> Int -> List (MutMsg s) (Field' (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Field' (MutMsg s)))

MutListElem s (CodeGeneratorRequest'RequestedFile'Import (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => CodeGeneratorRequest'RequestedFile'Import (MutMsg s) -> Int -> List (MutMsg s) (CodeGeneratorRequest'RequestedFile'Import (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (CodeGeneratorRequest'RequestedFile'Import (MutMsg s)))

MutListElem s (CodeGeneratorRequest'RequestedFile (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => CodeGeneratorRequest'RequestedFile (MutMsg s) -> Int -> List (MutMsg s) (CodeGeneratorRequest'RequestedFile (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (CodeGeneratorRequest'RequestedFile (MutMsg s)))

MutListElem s (Brand'Scope' (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Brand'Scope' (MutMsg s) -> Int -> List (MutMsg s) (Brand'Scope' (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Brand'Scope' (MutMsg s)))

MutListElem s (Brand'Scope (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Brand'Scope (MutMsg s) -> Int -> List (MutMsg s) (Brand'Scope (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Brand'Scope (MutMsg s)))

MutListElem s (Brand'Binding (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Brand'Binding (MutMsg s) -> Int -> List (MutMsg s) (Brand'Binding (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Brand'Binding (MutMsg s)))

MutListElem s (Value (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Value (MutMsg s) -> Int -> List (MutMsg s) (Value (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Value (MutMsg s)))

MutListElem s (Type (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Type (MutMsg s) -> Int -> List (MutMsg s) (Type (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Type (MutMsg s)))

MutListElem s (Superclass (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Superclass (MutMsg s) -> Int -> List (MutMsg s) (Superclass (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Superclass (MutMsg s)))

MutListElem s (Node (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Node (MutMsg s) -> Int -> List (MutMsg s) (Node (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Node (MutMsg s)))

MutListElem s (Method (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Method (MutMsg s) -> Int -> List (MutMsg s) (Method (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Method (MutMsg s)))

MutListElem s (Field (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Field (MutMsg s) -> Int -> List (MutMsg s) (Field (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Field (MutMsg s)))

MutListElem s (Enumerant (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Enumerant (MutMsg s) -> Int -> List (MutMsg s) (Enumerant (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Enumerant (MutMsg s)))

MutListElem s (CodeGeneratorRequest (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => CodeGeneratorRequest (MutMsg s) -> Int -> List (MutMsg s) (CodeGeneratorRequest (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (CodeGeneratorRequest (MutMsg s)))

MutListElem s (CapnpVersion (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => CapnpVersion (MutMsg s) -> Int -> List (MutMsg s) (CapnpVersion (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (CapnpVersion (MutMsg s)))

MutListElem s (Brand (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Brand (MutMsg s) -> Int -> List (MutMsg s) (Brand (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Brand (MutMsg s)))

MutListElem s (Annotation (MutMsg s))

Defined in Capnp.Capnp.Schema

Methods

setIndex :: RWCtx m s => Annotation (MutMsg s) -> Int -> List (MutMsg s) (Annotation (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Annotation (MutMsg s)))

MutListElem s (VatId (MutMsg s))

Defined in Capnp.Capnp.RpcTwoparty

Methods

setIndex :: RWCtx m s => VatId (MutMsg s) -> Int -> List (MutMsg s) (VatId (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (VatId (MutMsg s)))

MutListElem s (ProvisionId (MutMsg s))

Defined in Capnp.Capnp.RpcTwoparty

Methods

setIndex :: RWCtx m s => ProvisionId (MutMsg s) -> Int -> List (MutMsg s) (ProvisionId (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (ProvisionId (MutMsg s)))

MutListElem s (JoinResult (MutMsg s))

Defined in Capnp.Capnp.RpcTwoparty

Methods

setIndex :: RWCtx m s => JoinResult (MutMsg s) -> Int -> List (MutMsg s) (JoinResult (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (JoinResult (MutMsg s)))

MutListElem s (JoinKeyPart (MutMsg s))

Defined in Capnp.Capnp.RpcTwoparty

Methods

setIndex :: RWCtx m s => JoinKeyPart (MutMsg s) -> Int -> List (MutMsg s) (JoinKeyPart (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (JoinKeyPart (MutMsg s)))

MutListElem s (Return' (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Return' (MutMsg s) -> Int -> List (MutMsg s) (Return' (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Return' (MutMsg s)))

MutListElem s (Resolve' (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Resolve' (MutMsg s) -> Int -> List (MutMsg s) (Resolve' (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Resolve' (MutMsg s)))

MutListElem s (PromisedAnswer'Op (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => PromisedAnswer'Op (MutMsg s) -> Int -> List (MutMsg s) (PromisedAnswer'Op (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (PromisedAnswer'Op (MutMsg s)))

MutListElem s (ThirdPartyCapDescriptor (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => ThirdPartyCapDescriptor (MutMsg s) -> Int -> List (MutMsg s) (ThirdPartyCapDescriptor (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (ThirdPartyCapDescriptor (MutMsg s)))

MutListElem s (Return (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Return (MutMsg s) -> Int -> List (MutMsg s) (Return (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Return (MutMsg s)))

MutListElem s (Resolve (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Resolve (MutMsg s) -> Int -> List (MutMsg s) (Resolve (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Resolve (MutMsg s)))

MutListElem s (Release (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Release (MutMsg s) -> Int -> List (MutMsg s) (Release (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Release (MutMsg s)))

MutListElem s (Provide (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Provide (MutMsg s) -> Int -> List (MutMsg s) (Provide (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Provide (MutMsg s)))

MutListElem s (PromisedAnswer (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => PromisedAnswer (MutMsg s) -> Int -> List (MutMsg s) (PromisedAnswer (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (PromisedAnswer (MutMsg s)))

MutListElem s (Payload (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Payload (MutMsg s) -> Int -> List (MutMsg s) (Payload (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Payload (MutMsg s)))

MutListElem s (MessageTarget (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => MessageTarget (MutMsg s) -> Int -> List (MutMsg s) (MessageTarget (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (MessageTarget (MutMsg s)))

MutListElem s (Message (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Message (MutMsg s) -> Int -> List (MutMsg s) (Message (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Message (MutMsg s)))

MutListElem s (Join (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Join (MutMsg s) -> Int -> List (MutMsg s) (Join (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Join (MutMsg s)))

MutListElem s (Finish (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Finish (MutMsg s) -> Int -> List (MutMsg s) (Finish (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Finish (MutMsg s)))

MutListElem s (Exception (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Exception (MutMsg s) -> Int -> List (MutMsg s) (Exception (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Exception (MutMsg s)))

MutListElem s (Disembargo (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Disembargo (MutMsg s) -> Int -> List (MutMsg s) (Disembargo (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Disembargo (MutMsg s)))

MutListElem s (CapDescriptor (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => CapDescriptor (MutMsg s) -> Int -> List (MutMsg s) (CapDescriptor (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (CapDescriptor (MutMsg s)))

MutListElem s (Call (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Call (MutMsg s) -> Int -> List (MutMsg s) (Call (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Call (MutMsg s)))

MutListElem s (Bootstrap (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Bootstrap (MutMsg s) -> Int -> List (MutMsg s) (Bootstrap (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Bootstrap (MutMsg s)))

MutListElem s (Accept (MutMsg s))

Defined in Capnp.Capnp.Rpc

Methods

setIndex :: RWCtx m s => Accept (MutMsg s) -> Int -> List (MutMsg s) (Accept (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Accept (MutMsg s)))

MutListElem s (Persistent'SaveResults (MutMsg s))

Defined in Capnp.Capnp.Persistent

Methods

setIndex :: RWCtx m s => Persistent'SaveResults (MutMsg s) -> Int -> List (MutMsg s) (Persistent'SaveResults (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Persistent'SaveResults (MutMsg s)))

MutListElem s (Persistent'SaveParams (MutMsg s))

Defined in Capnp.Capnp.Persistent

Methods

setIndex :: RWCtx m s => Persistent'SaveParams (MutMsg s) -> Int -> List (MutMsg s) (Persistent'SaveParams (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (Persistent'SaveParams (MutMsg s)))

MutListElem s (JsonValue'Field (MutMsg s))

Defined in Capnp.Capnp.Json

Methods

setIndex :: RWCtx m s => JsonValue'Field (MutMsg s) -> Int -> List (MutMsg s) (JsonValue'Field (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (JsonValue'Field (MutMsg s)))

MutListElem s (JsonValue'Call (MutMsg s))

Defined in Capnp.Capnp.Json

Methods

setIndex :: RWCtx m s => JsonValue'Call (MutMsg s) -> Int -> List (MutMsg s) (JsonValue'Call (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (JsonValue'Call (MutMsg s)))

MutListElem s (JsonValue (MutMsg s))

Defined in Capnp.Capnp.Json

Methods

setIndex :: RWCtx m s => JsonValue (MutMsg s) -> Int -> List (MutMsg s) (JsonValue (MutMsg s)) -> m ()

newList :: WriteCtx m s => MutMsg s -> Int -> m (List (MutMsg s) (JsonValue (MutMsg s)))

Eq (MutMsg s)

Defined in Data.Capnp.Message

Methods

(==) :: MutMsg s -> MutMsg s -> Bool

(/=) :: MutMsg s -> MutMsg s -> Bool

data Segment (MutMsg s)

Defined in Data.Capnp.Message

data Segment (MutMsg s) = MutSegment (AppendVec MVector s Word64)

newMessage :: WriteCtx m s => m (MutMsg s)

Allocate a new empty message.

Allocating space in messages

alloc :: WriteCtx m s => MutMsg s -> WordCount -> m WordAddr

alloc size allocates size words within a message. it returns the starting address of the allocated memory.

allocInSeg :: WriteCtx m s => MutMsg s -> Int -> WordCount -> m WordAddr

Like alloc, but the second argument allows the caller to specify the index of the segment in which to allocate the data.

newSegment :: WriteCtx m s => MutMsg s -> Int -> m (Int, Segment (MutMsg s))

newSegment msg sizeHint allocates a new, initially empty segment in msg with a capacity of sizeHint. It returns the a pair of the segment number and the segment itself. Amortized O(1).

Modifying messages

setWord :: (WriteCtx m s, MonadThrow m) => MutMsg s -> WordAddr -> Word64 -> m ()

setWord message address value sets the word at address in the message to value. If the address is not valid in the message, a BoundsError will be thrown.

setSegment :: (WriteCtx m s, MonadThrow m) => MutMsg s -> Int -> Segment (MutMsg s) -> m ()

setSegment message index segment sets the segment at the given index in the message. It throws a BoundsError if the address is out of bounds.

type WriteCtx m s = (PrimMonad m, s ~ PrimState m, MonadThrow m)

WriteCtx is the context needed for most write operations.