Data.Capnp.Untyped

The types and functions in this module know about things like structs and lists, but are not schema aware.

Each of the data types exported by this module is parametrized over a Message type (see Message), used as the underlying storage.

Documentation

data Ptr msg

A an absolute pointer to a value (of arbitrary type) in a message. Note that there is no variant for far pointers, which don't make sense with absolute addressing.

Constructors

PtrCap msg !Word32

PtrList (List msg)

PtrStruct (Struct msg)

Instances

IsPtr msg (Maybe (Ptr msg))

IsPtr instance for pointers -- this is just the identity.

Defined in Data.Capnp.Classes

Methods

fromPtr :: ReadCtx m msg => msg -> Maybe (Ptr msg) -> m (Maybe (Ptr msg))

toPtr :: Maybe (Ptr msg) -> Maybe (Ptr msg)

Mutable msg => Mutable (Ptr msg)

Defined in Data.Capnp.Untyped

Associated Types

type Scope (Ptr msg) :: *

type Frozen (Ptr msg) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (Ptr msg)) => Frozen (Ptr msg) -> m (Ptr msg)

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (Ptr msg)) => Ptr msg -> m (Frozen (Ptr msg))

HasMessage (Ptr msg) msg

Defined in Data.Capnp.Untyped

Methods

message :: Ptr msg -> msg

Mutable msg => Mutable (ListOf msg (Maybe (Ptr msg)))

Defined in Data.Capnp.Untyped

Associated Types

type Scope (ListOf msg (Maybe (Ptr msg))) :: *

type Frozen (ListOf msg (Maybe (Ptr msg))) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg (Maybe (Ptr msg)))) => Frozen (ListOf msg (Maybe (Ptr msg))) -> m (ListOf msg (Maybe (Ptr msg)))

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg (Maybe (Ptr msg)))) => ListOf msg (Maybe (Ptr msg)) -> m (Frozen (ListOf msg (Maybe (Ptr msg))))

MessageDefault (ListOf msg (Maybe (Ptr msg))) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg (Maybe (Ptr msg))

type Scope (Ptr msg)

Defined in Data.Capnp.Untyped

type Scope (Ptr msg) = Scope msg

type Frozen (Ptr msg)

Defined in Data.Capnp.Untyped

type Frozen (Ptr msg) = Ptr (Frozen msg)

type Scope (ListOf msg (Maybe (Ptr msg)))

Defined in Data.Capnp.Untyped

type Scope (ListOf msg (Maybe (Ptr msg))) = Scope msg

type Frozen (ListOf msg (Maybe (Ptr msg)))

Defined in Data.Capnp.Untyped

type Frozen (ListOf msg (Maybe (Ptr msg))) = ListOf (Frozen msg) (Maybe (Ptr (Frozen msg)))

data List msg

A list of values (of arbitrary type) in a message.

Constructors

List0 (ListOf msg ())

List1 (ListOf msg Bool)

List8 (ListOf msg Word8)

List16 (ListOf msg Word16)

List32 (ListOf msg Word32)

List64 (ListOf msg Word64)

ListPtr (ListOf msg (Maybe (Ptr msg)))

ListStruct (ListOf msg (Struct msg))

Instances

Mutable msg => Mutable (List msg)

Defined in Data.Capnp.Untyped

Associated Types

type Scope (List msg) :: *

type Frozen (List msg) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (List msg)) => Frozen (List msg) -> m (List msg)

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (List msg)) => List msg -> m (Frozen (List msg))

HasMessage (List msg) msg

Defined in Data.Capnp.Untyped

Methods

message :: List msg -> msg

type Scope (List msg)

Defined in Data.Capnp.Untyped

type Scope (List msg) = Scope msg

type Frozen (List msg)

Defined in Data.Capnp.Untyped

type Frozen (List msg) = List (Frozen msg)

data Struct msg

A struct value in a message.

Instances

ToStruct msg (Struct msg)

Defined in Data.Capnp.Classes

Methods

toStruct :: Struct msg -> Struct msg

FromStruct msg (Struct msg)

Defined in Data.Capnp.Classes

Methods

fromStruct :: ReadCtx m msg => Struct msg -> m (Struct msg)

IsPtr msg (Struct msg)

Defined in Data.Capnp.Classes

Methods

fromPtr :: ReadCtx m msg => msg -> Maybe (Ptr msg) -> m (Struct msg)

toPtr :: Struct msg -> Maybe (Ptr msg)

IsPtr msg (ListOf msg (Struct msg))

Defined in Data.Capnp.Classes

Methods

fromPtr :: ReadCtx m msg => msg -> Maybe (Ptr msg) -> m (ListOf msg (Struct msg))

toPtr :: ListOf msg (Struct msg) -> Maybe (Ptr msg)

Mutable msg => Mutable (Struct msg)

Defined in Data.Capnp.Untyped

Associated Types

type Scope (Struct msg) :: *

type Frozen (Struct msg) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (Struct msg)) => Frozen (Struct msg) -> m (Struct msg)

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (Struct msg)) => Struct msg -> m (Frozen (Struct msg))

MessageDefault (Struct msg) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> Struct msg

HasMessage (Struct msg) msg

Defined in Data.Capnp.Untyped

Methods

message :: Struct msg -> msg

Mutable msg => Mutable (ListOf msg (Struct msg))

Defined in Data.Capnp.Untyped

Associated Types

type Scope (ListOf msg (Struct msg)) :: *

type Frozen (ListOf msg (Struct msg)) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg (Struct msg))) => Frozen (ListOf msg (Struct msg)) -> m (ListOf msg (Struct msg))

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg (Struct msg))) => ListOf msg (Struct msg) -> m (Frozen (ListOf msg (Struct msg)))

MessageDefault (ListOf msg (Struct msg)) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg (Struct msg)

type Scope (Struct msg)

Defined in Data.Capnp.Untyped

type Scope (Struct msg) = Scope msg

type Frozen (Struct msg)

Defined in Data.Capnp.Untyped

type Frozen (Struct msg) = Struct (Frozen msg)

type Scope (ListOf msg (Struct msg))

Defined in Data.Capnp.Untyped

type Scope (ListOf msg (Struct msg)) = Scope msg

type Frozen (ListOf msg (Struct msg))

Defined in Data.Capnp.Untyped

type Frozen (ListOf msg (Struct msg)) = ListOf (Frozen msg) (Struct (Frozen msg))

data ListOf msg a

A list of values of type a in a message.

Instances

IsPtr msg (ListOf msg (Struct msg))

Defined in Data.Capnp.Classes

Methods

fromPtr :: ReadCtx m msg => msg -> Maybe (Ptr msg) -> m (ListOf msg (Struct msg))

toPtr :: ListOf msg (Struct msg) -> Maybe (Ptr msg)

IsPtr msg (ListOf msg Bool)

Defined in Data.Capnp.Classes

Methods

fromPtr :: ReadCtx m msg => msg -> Maybe (Ptr msg) -> m (ListOf msg Bool)

toPtr :: ListOf msg Bool -> Maybe (Ptr msg)

IsPtr msg (ListOf msg Word64)

Defined in Data.Capnp.Classes

Methods

fromPtr :: ReadCtx m msg => msg -> Maybe (Ptr msg) -> m (ListOf msg Word64)

toPtr :: ListOf msg Word64 -> Maybe (Ptr msg)

IsPtr msg (ListOf msg Word32)

Defined in Data.Capnp.Classes

Methods

fromPtr :: ReadCtx m msg => msg -> Maybe (Ptr msg) -> m (ListOf msg Word32)

toPtr :: ListOf msg Word32 -> Maybe (Ptr msg)

IsPtr msg (ListOf msg Word16)

Defined in Data.Capnp.Classes

Methods

fromPtr :: ReadCtx m msg => msg -> Maybe (Ptr msg) -> m (ListOf msg Word16)

toPtr :: ListOf msg Word16 -> Maybe (Ptr msg)

IsPtr msg (ListOf msg Word8)

Defined in Data.Capnp.Classes

Methods

fromPtr :: ReadCtx m msg => msg -> Maybe (Ptr msg) -> m (ListOf msg Word8)

toPtr :: ListOf msg Word8 -> Maybe (Ptr msg)

IsPtr msg (ListOf msg ())

Defined in Data.Capnp.Classes

Methods

fromPtr :: ReadCtx m msg => msg -> Maybe (Ptr msg) -> m (ListOf msg ())

toPtr :: ListOf msg () -> Maybe (Ptr msg)

Mutable msg => Mutable (ListOf msg (Maybe (Ptr msg)))

Defined in Data.Capnp.Untyped

Associated Types

type Scope (ListOf msg (Maybe (Ptr msg))) :: *

type Frozen (ListOf msg (Maybe (Ptr msg))) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg (Maybe (Ptr msg)))) => Frozen (ListOf msg (Maybe (Ptr msg))) -> m (ListOf msg (Maybe (Ptr msg)))

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg (Maybe (Ptr msg)))) => ListOf msg (Maybe (Ptr msg)) -> m (Frozen (ListOf msg (Maybe (Ptr msg))))

Mutable msg => Mutable (ListOf msg (Struct msg))

Defined in Data.Capnp.Untyped

Associated Types

type Scope (ListOf msg (Struct msg)) :: *

type Frozen (ListOf msg (Struct msg)) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg (Struct msg))) => Frozen (ListOf msg (Struct msg)) -> m (ListOf msg (Struct msg))

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg (Struct msg))) => ListOf msg (Struct msg) -> m (Frozen (ListOf msg (Struct msg)))

Mutable msg => Mutable (ListOf msg Word64)

Defined in Data.Capnp.Untyped

Associated Types

type Scope (ListOf msg Word64) :: *

type Frozen (ListOf msg Word64) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg Word64)) => Frozen (ListOf msg Word64) -> m (ListOf msg Word64)

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg Word64)) => ListOf msg Word64 -> m (Frozen (ListOf msg Word64))

Mutable msg => Mutable (ListOf msg Word32)

Defined in Data.Capnp.Untyped

Associated Types

type Scope (ListOf msg Word32) :: *

type Frozen (ListOf msg Word32) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg Word32)) => Frozen (ListOf msg Word32) -> m (ListOf msg Word32)

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg Word32)) => ListOf msg Word32 -> m (Frozen (ListOf msg Word32))

Mutable msg => Mutable (ListOf msg Word16)

Defined in Data.Capnp.Untyped

Associated Types

type Scope (ListOf msg Word16) :: *

type Frozen (ListOf msg Word16) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg Word16)) => Frozen (ListOf msg Word16) -> m (ListOf msg Word16)

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg Word16)) => ListOf msg Word16 -> m (Frozen (ListOf msg Word16))

Mutable msg => Mutable (ListOf msg Word8)

Defined in Data.Capnp.Untyped

Associated Types

type Scope (ListOf msg Word8) :: *

type Frozen (ListOf msg Word8) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg Word8)) => Frozen (ListOf msg Word8) -> m (ListOf msg Word8)

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg Word8)) => ListOf msg Word8 -> m (Frozen (ListOf msg Word8))

Mutable msg => Mutable (ListOf msg Bool)

Defined in Data.Capnp.Untyped

Associated Types

type Scope (ListOf msg Bool) :: *

type Frozen (ListOf msg Bool) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg Bool)) => Frozen (ListOf msg Bool) -> m (ListOf msg Bool)

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg Bool)) => ListOf msg Bool -> m (Frozen (ListOf msg Bool))

Mutable msg => Mutable (ListOf msg ())

Defined in Data.Capnp.Untyped

Associated Types

type Scope (ListOf msg ()) :: *

type Frozen (ListOf msg ()) :: *

Methods

thaw :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg ())) => Frozen (ListOf msg ()) -> m (ListOf msg ())

freeze :: (MonadThrow m, PrimMonad m, PrimState m ~ Scope (ListOf msg ())) => ListOf msg () -> m (Frozen (ListOf msg ()))

MessageDefault (ListOf msg (Maybe (Ptr msg))) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg (Maybe (Ptr msg))

MessageDefault (ListOf msg Word64) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg Word64

MessageDefault (ListOf msg Word32) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg Word32

MessageDefault (ListOf msg Word16) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg Word16

MessageDefault (ListOf msg Word8) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg Word8

MessageDefault (ListOf msg Bool) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg Bool

MessageDefault (ListOf msg (Struct msg)) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg (Struct msg)

MessageDefault (ListOf msg ()) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg ()

HasMessage (ListOf msg a) msg

Defined in Data.Capnp.Untyped

Methods

message :: ListOf msg a -> msg

type Scope (ListOf msg (Maybe (Ptr msg)))

Defined in Data.Capnp.Untyped

type Scope (ListOf msg (Maybe (Ptr msg))) = Scope msg

type Scope (ListOf msg (Struct msg))

Defined in Data.Capnp.Untyped

type Scope (ListOf msg (Struct msg)) = Scope msg

type Scope (ListOf msg Word64)

Defined in Data.Capnp.Untyped

type Scope (ListOf msg Word64) = Scope msg

type Scope (ListOf msg Word32)

Defined in Data.Capnp.Untyped

type Scope (ListOf msg Word32) = Scope msg

type Scope (ListOf msg Word16)

Defined in Data.Capnp.Untyped

type Scope (ListOf msg Word16) = Scope msg

type Scope (ListOf msg Word8)

Defined in Data.Capnp.Untyped

type Scope (ListOf msg Word8) = Scope msg

type Scope (ListOf msg Bool)

Defined in Data.Capnp.Untyped

type Scope (ListOf msg Bool) = Scope msg

type Scope (ListOf msg ())

Defined in Data.Capnp.Untyped

type Scope (ListOf msg ()) = Scope msg

type Frozen (ListOf msg (Maybe (Ptr msg)))

Defined in Data.Capnp.Untyped

type Frozen (ListOf msg (Maybe (Ptr msg))) = ListOf (Frozen msg) (Maybe (Ptr (Frozen msg)))

type Frozen (ListOf msg (Struct msg))

Defined in Data.Capnp.Untyped

type Frozen (ListOf msg (Struct msg)) = ListOf (Frozen msg) (Struct (Frozen msg))

type Frozen (ListOf msg Word64)

Defined in Data.Capnp.Untyped

type Frozen (ListOf msg Word64) = ListOf (Frozen msg) Word64

type Frozen (ListOf msg Word32)

Defined in Data.Capnp.Untyped

type Frozen (ListOf msg Word32) = ListOf (Frozen msg) Word32

type Frozen (ListOf msg Word16)

Defined in Data.Capnp.Untyped

type Frozen (ListOf msg Word16) = ListOf (Frozen msg) Word16

type Frozen (ListOf msg Word8)

Defined in Data.Capnp.Untyped

type Frozen (ListOf msg Word8) = ListOf (Frozen msg) Word8

type Frozen (ListOf msg Bool)

Defined in Data.Capnp.Untyped

type Frozen (ListOf msg Bool) = ListOf (Frozen msg) Bool

type Frozen (ListOf msg ())

Defined in Data.Capnp.Untyped

type Frozen (ListOf msg ()) = ListOf (Frozen msg) ()

dataSection :: Struct msg -> ListOf msg Word64

The data section of a struct, as a list of Word64

ptrSection :: Struct msg -> ListOf msg (Maybe (Ptr msg))

The pointer section of a struct, as a list of Ptr

getData :: ReadCtx m msg => Int -> Struct msg -> m Word64

getData i struct gets the ith word from the struct's data section, returning 0 if it is absent.

getPtr :: ReadCtx m msg => Int -> Struct msg -> m (Maybe (Ptr msg))

getPtr i struct gets the ith word from the struct's pointer section, returning Nothing if it is absent.

setData :: (ReadCtx m (MutMsg s), WriteCtx m s) => Word64 -> Int -> Struct (MutMsg s) -> m ()

setData value i struct sets the ith word in the struct's data section to value.

setPtr :: (ReadCtx m (MutMsg s), WriteCtx m s) => Maybe (Ptr (MutMsg s)) -> Int -> Struct (MutMsg s) -> m ()

setData value i struct sets the ith pointer in the struct's pointer section to value.

copyStruct :: (ReadCtx m (MutMsg s), WriteCtx m s) => Struct (MutMsg s) -> Struct (MutMsg s) -> m ()

copyStruct dest src copies the source struct to the destination struct.

get :: ReadCtx m msg => msg -> WordAddr -> m (Maybe (Ptr msg))

get msg addr returns the Ptr stored at addr in msg. Deducts 1 from the quota for each word read (which may be multiple in the case of far pointers).

index :: ReadCtx m msg => Int -> ListOf msg a -> m a

index i list returns the ith element in list. Deducts 1 from the quota

length :: ListOf msg a -> Int

Returns the length of a list

setIndex :: (ReadCtx m (MutMsg s), WriteCtx m s) => a -> Int -> ListOf (MutMsg s) a -> m ()

'setIndex value i list Set the ith element of list to value.

take :: MonadThrow m => Int -> ListOf msg a -> m (ListOf msg a)

Return a prefix of the list, of the given length.

rootPtr :: ReadCtx m msg => msg -> m (Struct msg)

Returns the root pointer of a message.

setRoot :: WriteCtx m s => Struct (MutMsg s) -> m ()

Make the given struct the root object of its message.

rawBytes :: ReadCtx m msg => ListOf msg Word8 -> m ByteString

rawBytes returns the raw bytes corresponding to the list.

type ReadCtx m msg = (Message m msg, MonadThrow m, MonadLimit m)

Type (constraint) synonym for the constraints needed for most read operations.

type RWCtx m s = (ReadCtx m (MutMsg s), WriteCtx m s)

Synonym for ReadCtx + WriteCtx

class HasMessage a msg where

Types a whose storage is owned by a message with blob type b.

Minimal complete definition

message

Methods

message :: a -> msg

Get the message in which the a is stored.

Instances

HasMessage (Struct msg) msg

Defined in Data.Capnp.Untyped

Methods

message :: Struct msg -> msg

HasMessage (List msg) msg

Defined in Data.Capnp.Untyped

Methods

message :: List msg -> msg

HasMessage (Ptr msg) msg

Defined in Data.Capnp.Untyped

Methods

message :: Ptr msg -> msg

HasMessage (Type'anyPointer'unconstrained msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Type'anyPointer'unconstrained msg -> msg

HasMessage (Type'anyPointer'implicitMethodParameter'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Type'anyPointer'implicitMethodParameter'group' msg -> msg

HasMessage (Type'anyPointer'parameter'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Type'anyPointer'parameter'group' msg -> msg

HasMessage (Type'anyPointer'unconstrained'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Type'anyPointer'unconstrained'group' msg -> msg

HasMessage (Type'anyPointer msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Type'anyPointer msg -> msg

HasMessage (Node'Parameter msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Node'Parameter msg -> msg

HasMessage (Node'NestedNode msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Node'NestedNode msg -> msg

HasMessage (Node'annotation'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Node'annotation'group' msg -> msg

HasMessage (Node'const'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Node'const'group' msg -> msg

HasMessage (Node'interface'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Node'interface'group' msg -> msg

HasMessage (Node'enum'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Node'enum'group' msg -> msg

HasMessage (Node'struct'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Node'struct'group' msg -> msg

HasMessage (Node' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Node' msg -> msg

HasMessage (Field'ordinal msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Field'ordinal msg -> msg

HasMessage (Field'group'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Field'group'group' msg -> msg

HasMessage (Field'slot'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Field'slot'group' msg -> msg

HasMessage (Field' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Field' msg -> msg

HasMessage (CodeGeneratorRequest'RequestedFile'Import msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: CodeGeneratorRequest'RequestedFile'Import msg -> msg

HasMessage (CodeGeneratorRequest'RequestedFile msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: CodeGeneratorRequest'RequestedFile msg -> msg

HasMessage (Brand'Scope' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Brand'Scope' msg -> msg

HasMessage (Brand'Scope msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Brand'Scope msg -> msg

HasMessage (Brand'Binding msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Brand'Binding msg -> msg

HasMessage (Value msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Value msg -> msg

HasMessage (Type'anyPointer'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Type'anyPointer'group' msg -> msg

HasMessage (Type'interface'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Type'interface'group' msg -> msg

HasMessage (Type'struct'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Type'struct'group' msg -> msg

HasMessage (Type'enum'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Type'enum'group' msg -> msg

HasMessage (Type'list'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Type'list'group' msg -> msg

HasMessage (Type msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Type msg -> msg

HasMessage (Superclass msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Superclass msg -> msg

HasMessage (Node msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Node msg -> msg

HasMessage (Method msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Method msg -> msg

HasMessage (Field msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Field msg -> msg

HasMessage (Enumerant msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Enumerant msg -> msg

HasMessage (CodeGeneratorRequest msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: CodeGeneratorRequest msg -> msg

HasMessage (CapnpVersion msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: CapnpVersion msg -> msg

HasMessage (Brand msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Brand msg -> msg

HasMessage (Annotation msg) msg

Defined in Capnp.Capnp.Schema

Methods

message :: Annotation msg -> msg

HasMessage (VatId msg) msg

Defined in Capnp.Capnp.RpcTwoparty

Methods

message :: VatId msg -> msg

HasMessage (ProvisionId msg) msg

Defined in Capnp.Capnp.RpcTwoparty

Methods

message :: ProvisionId msg -> msg

HasMessage (JoinResult msg) msg

Defined in Capnp.Capnp.RpcTwoparty

Methods

message :: JoinResult msg -> msg

HasMessage (JoinKeyPart msg) msg

Defined in Capnp.Capnp.RpcTwoparty

Methods

message :: JoinKeyPart msg -> msg

HasMessage (Return' msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Return' msg -> msg

HasMessage (Resolve' msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Resolve' msg -> msg

HasMessage (PromisedAnswer'Op msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: PromisedAnswer'Op msg -> msg

HasMessage (Disembargo'context msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Disembargo'context msg -> msg

HasMessage (Call'sendResultsTo msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Call'sendResultsTo msg -> msg

HasMessage (ThirdPartyCapDescriptor msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: ThirdPartyCapDescriptor msg -> msg

HasMessage (Return msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Return msg -> msg

HasMessage (Resolve msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Resolve msg -> msg

HasMessage (Release msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Release msg -> msg

HasMessage (Provide msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Provide msg -> msg

HasMessage (PromisedAnswer msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: PromisedAnswer msg -> msg

HasMessage (Payload msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Payload msg -> msg

HasMessage (MessageTarget msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: MessageTarget msg -> msg

HasMessage (Message msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Message msg -> msg

HasMessage (Join msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Join msg -> msg

HasMessage (Finish msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Finish msg -> msg

HasMessage (Exception msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Exception msg -> msg

HasMessage (Disembargo msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Disembargo msg -> msg

HasMessage (CapDescriptor msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: CapDescriptor msg -> msg

HasMessage (Call msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Call msg -> msg

HasMessage (Bootstrap msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Bootstrap msg -> msg

HasMessage (Accept msg) msg

Defined in Capnp.Capnp.Rpc

Methods

message :: Accept msg -> msg

HasMessage (Persistent'SaveResults msg) msg

Defined in Capnp.Capnp.Persistent

Methods

message :: Persistent'SaveResults msg -> msg

HasMessage (Persistent'SaveParams msg) msg

Defined in Capnp.Capnp.Persistent

Methods

message :: Persistent'SaveParams msg -> msg

HasMessage (JsonValue'Field msg) msg

Defined in Capnp.Capnp.Json

Methods

message :: JsonValue'Field msg -> msg

HasMessage (JsonValue'Call msg) msg

Defined in Capnp.Capnp.Json

Methods

message :: JsonValue'Call msg -> msg

HasMessage (JsonValue msg) msg

Defined in Capnp.Capnp.Json

Methods

message :: JsonValue msg -> msg

HasMessage (ListOf msg a) msg

Defined in Data.Capnp.Untyped

Methods

message :: ListOf msg a -> msg

class HasMessage a msg => MessageDefault a msg where

Types which have a "default" value, but require a message to construct it.

The default is usually conceptually zero-size. This is mostly useful for generated code, so that it can use standard decoding techniques on default values.

Minimal complete definition

messageDefault

Methods

messageDefault :: msg -> a

Instances

MessageDefault (Struct msg) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> Struct msg

MessageDefault (Type'anyPointer'unconstrained msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Type'anyPointer'unconstrained msg

MessageDefault (Type'anyPointer'implicitMethodParameter'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Type'anyPointer'implicitMethodParameter'group' msg

MessageDefault (Type'anyPointer'parameter'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Type'anyPointer'parameter'group' msg

MessageDefault (Type'anyPointer'unconstrained'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Type'anyPointer'unconstrained'group' msg

MessageDefault (Type'anyPointer msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Type'anyPointer msg

MessageDefault (Node'Parameter msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Node'Parameter msg

MessageDefault (Node'NestedNode msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Node'NestedNode msg

MessageDefault (Node'annotation'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Node'annotation'group' msg

MessageDefault (Node'const'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Node'const'group' msg

MessageDefault (Node'interface'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Node'interface'group' msg

MessageDefault (Node'enum'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Node'enum'group' msg

MessageDefault (Node'struct'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Node'struct'group' msg

MessageDefault (Node' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Node' msg

MessageDefault (Field'ordinal msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Field'ordinal msg

MessageDefault (Field'group'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Field'group'group' msg

MessageDefault (Field'slot'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Field'slot'group' msg

MessageDefault (Field' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Field' msg

MessageDefault (CodeGeneratorRequest'RequestedFile'Import msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> CodeGeneratorRequest'RequestedFile'Import msg

MessageDefault (CodeGeneratorRequest'RequestedFile msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> CodeGeneratorRequest'RequestedFile msg

MessageDefault (Brand'Scope' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Brand'Scope' msg

MessageDefault (Brand'Scope msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Brand'Scope msg

MessageDefault (Brand'Binding msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Brand'Binding msg

MessageDefault (Value msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Value msg

MessageDefault (Type'anyPointer'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Type'anyPointer'group' msg

MessageDefault (Type'interface'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Type'interface'group' msg

MessageDefault (Type'struct'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Type'struct'group' msg

MessageDefault (Type'enum'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Type'enum'group' msg

MessageDefault (Type'list'group' msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Type'list'group' msg

MessageDefault (Type msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Type msg

MessageDefault (Superclass msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Superclass msg

MessageDefault (Node msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Node msg

MessageDefault (Method msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Method msg

MessageDefault (Field msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Field msg

MessageDefault (Enumerant msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Enumerant msg

MessageDefault (CodeGeneratorRequest msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> CodeGeneratorRequest msg

MessageDefault (CapnpVersion msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> CapnpVersion msg

MessageDefault (Brand msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Brand msg

MessageDefault (Annotation msg) msg

Defined in Capnp.Capnp.Schema

Methods

messageDefault :: msg -> Annotation msg

MessageDefault (VatId msg) msg

Defined in Capnp.Capnp.RpcTwoparty

Methods

messageDefault :: msg -> VatId msg

MessageDefault (ProvisionId msg) msg

Defined in Capnp.Capnp.RpcTwoparty

Methods

messageDefault :: msg -> ProvisionId msg

MessageDefault (JoinResult msg) msg

Defined in Capnp.Capnp.RpcTwoparty

Methods

messageDefault :: msg -> JoinResult msg

MessageDefault (JoinKeyPart msg) msg

Defined in Capnp.Capnp.RpcTwoparty

Methods

messageDefault :: msg -> JoinKeyPart msg

MessageDefault (Return' msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Return' msg

MessageDefault (Resolve' msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Resolve' msg

MessageDefault (PromisedAnswer'Op msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> PromisedAnswer'Op msg

MessageDefault (Disembargo'context msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Disembargo'context msg

MessageDefault (Call'sendResultsTo msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Call'sendResultsTo msg

MessageDefault (ThirdPartyCapDescriptor msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> ThirdPartyCapDescriptor msg

MessageDefault (Return msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Return msg

MessageDefault (Resolve msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Resolve msg

MessageDefault (Release msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Release msg

MessageDefault (Provide msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Provide msg

MessageDefault (PromisedAnswer msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> PromisedAnswer msg

MessageDefault (Payload msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Payload msg

MessageDefault (MessageTarget msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> MessageTarget msg

MessageDefault (Message msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Message msg

MessageDefault (Join msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Join msg

MessageDefault (Finish msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Finish msg

MessageDefault (Exception msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Exception msg

MessageDefault (Disembargo msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Disembargo msg

MessageDefault (CapDescriptor msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> CapDescriptor msg

MessageDefault (Call msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Call msg

MessageDefault (Bootstrap msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Bootstrap msg

MessageDefault (Accept msg) msg

Defined in Capnp.Capnp.Rpc

Methods

messageDefault :: msg -> Accept msg

MessageDefault (Persistent'SaveResults msg) msg

Defined in Capnp.Capnp.Persistent

Methods

messageDefault :: msg -> Persistent'SaveResults msg

MessageDefault (Persistent'SaveParams msg) msg

Defined in Capnp.Capnp.Persistent

Methods

messageDefault :: msg -> Persistent'SaveParams msg

MessageDefault (JsonValue'Field msg) msg

Defined in Capnp.Capnp.Json

Methods

messageDefault :: msg -> JsonValue'Field msg

MessageDefault (JsonValue'Call msg) msg

Defined in Capnp.Capnp.Json

Methods

messageDefault :: msg -> JsonValue'Call msg

MessageDefault (JsonValue msg) msg

Defined in Capnp.Capnp.Json

Methods

messageDefault :: msg -> JsonValue msg

MessageDefault (ListOf msg (Maybe (Ptr msg))) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg (Maybe (Ptr msg))

MessageDefault (ListOf msg Word64) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg Word64

MessageDefault (ListOf msg Word32) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg Word32

MessageDefault (ListOf msg Word16) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg Word16

MessageDefault (ListOf msg Word8) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg Word8

MessageDefault (ListOf msg Bool) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg Bool

MessageDefault (ListOf msg (Struct msg)) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg (Struct msg)

MessageDefault (ListOf msg ()) msg

Defined in Data.Capnp.Untyped

Methods

messageDefault :: msg -> ListOf msg ()

allocStruct :: WriteCtx m s => MutMsg s -> Word16 -> Word16 -> m (Struct (MutMsg s))

Allocate a struct in the message.

allocCompositeList

Arguments

:: WriteCtx m s

=> MutMsg s

The message to allocate in.

-> Word16

The size of the data sections

-> Word16

The size of the pointer sections

-> Int

The length of the list in elements.

-> m (ListOf (MutMsg s) (Struct (MutMsg s)))

Allocate a composite list.

allocList0 :: WriteCtx m s => MutMsg s -> Int -> m (ListOf (MutMsg s) ())

Allocate a list of capnproto Void values.

allocList1 :: WriteCtx m s => MutMsg s -> Int -> m (ListOf (MutMsg s) Bool)

Allocate a list of booleans

allocList8 :: WriteCtx m s => MutMsg s -> Int -> m (ListOf (MutMsg s) Word8)

Allocate a list of 8-bit values.

allocList16 :: WriteCtx m s => MutMsg s -> Int -> m (ListOf (MutMsg s) Word16)

Allocate a list of 16-bit values.

allocList32 :: WriteCtx m s => MutMsg s -> Int -> m (ListOf (MutMsg s) Word32)

Allocate a list of 32-bit values.

allocList64 :: WriteCtx m s => MutMsg s -> Int -> m (ListOf (MutMsg s) Word64)

Allocate a list of 64-bit words.

allocListPtr :: WriteCtx m s => MutMsg s -> Int -> m (ListOf (MutMsg s) (Maybe (Ptr (MutMsg s))))

Allocate a list of pointers.