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 the mutability of the message it contains (see Capnp.Message).

Documentation

data Ptr mut

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 (Cap mut)

PtrList (List mut)

PtrStruct (Struct mut)

Instances

TraverseMsg Ptr

Defined in Capnp.Untyped

Methods

tMsg :: forall m (mutA :: Mutability) (mutB :: Mutability). TraverseMsgCtx m mutA mutB => (Message mutA -> m (Message mutB)) -> Ptr mutA -> m (Ptr mutB)

ToPtr s (Maybe (Ptr ('Mut s)))

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> Maybe (Ptr ('Mut s)) -> m (Maybe (Ptr ('Mut s)))

FromPtr mut (Maybe (Ptr mut))

Defined in Capnp.Classes

Methods

fromPtr :: ReadCtx m mut => Message mut -> Maybe (Ptr mut) -> m (Maybe (Ptr mut))

ToPtr s (ListOf ('Mut s) (Maybe (Ptr ('Mut s))))

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> ListOf ('Mut s) (Maybe (Ptr ('Mut s))) -> m (Maybe (Ptr ('Mut s)))

FromPtr mut (ListOf mut (Maybe (Ptr mut)))

Defined in Capnp.Classes

Methods

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

Thaw (Ptr 'Const)

Defined in Capnp.Untyped

Associated Types

type Mutable s (Ptr 'Const)

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => Ptr 'Const -> m (Mutable s (Ptr 'Const))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (Ptr 'Const) -> m (Ptr 'Const)

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => Ptr 'Const -> m (Mutable s (Ptr 'Const))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (Ptr 'Const) -> m (Ptr 'Const)

HasMessage (Ptr mut) mut

Defined in Capnp.Untyped

Methods

message :: Ptr mut -> Message mut

Thaw (ListOf 'Const (Maybe (Ptr 'Const)))

Defined in Capnp.Untyped

Associated Types

type Mutable s (ListOf 'Const (Maybe (Ptr 'Const)))

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const (Maybe (Ptr 'Const)) -> m (Mutable s (ListOf 'Const (Maybe (Ptr 'Const))))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const (Maybe (Ptr 'Const))) -> m (ListOf 'Const (Maybe (Ptr 'Const)))

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const (Maybe (Ptr 'Const)) -> m (Mutable s (ListOf 'Const (Maybe (Ptr 'Const))))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const (Maybe (Ptr 'Const))) -> m (ListOf 'Const (Maybe (Ptr 'Const)))

MessageDefault (ListOf mut (Maybe (Ptr mut))) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut (Maybe (Ptr mut)))

type Mutable s (Ptr 'Const)

Defined in Capnp.Untyped

type Mutable s (Ptr 'Const) = Ptr ('Mut s)

type Mutable s (ListOf 'Const (Maybe (Ptr 'Const)))

Defined in Capnp.Untyped

type Mutable s (ListOf 'Const (Maybe (Ptr 'Const))) = ListOf ('Mut s) (Maybe (Ptr ('Mut s)))

type ReprFor (Ptr mut)

Defined in Capnp.Repr

type ReprFor (Ptr mut) = 'Ptr ('Nothing :: Maybe PtrRepr)

data List mut

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

Constructors

List0 (ListOf mut ())

List1 (ListOf mut Bool)

List8 (ListOf mut Word8)

List16 (ListOf mut Word16)

List32 (ListOf mut Word32)

List64 (ListOf mut Word64)

ListPtr (ListOf mut (Maybe (Ptr mut)))

ListStruct (ListOf mut (Struct mut))

Instances

TraverseMsg List

Defined in Capnp.Untyped

Methods

tMsg :: forall m (mutA :: Mutability) (mutB :: Mutability). TraverseMsgCtx m mutA mutB => (Message mutA -> m (Message mutB)) -> List mutA -> m (List mutB)

Thaw (List 'Const)

Defined in Capnp.Untyped

Associated Types

type Mutable s (List 'Const)

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => List 'Const -> m (Mutable s (List 'Const))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (List 'Const) -> m (List 'Const)

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => List 'Const -> m (Mutable s (List 'Const))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (List 'Const) -> m (List 'Const)

HasMessage (List mut) mut

Defined in Capnp.Untyped

Methods

message :: List mut -> Message mut

type Mutable s (List 'Const)

Defined in Capnp.Untyped

type Mutable s (List 'Const) = List ('Mut s)

type ReprFor (List mut)

Defined in Capnp.Repr

type ReprFor (List mut) = 'Ptr ('Just ('List ('Nothing :: Maybe ListRepr)))

data Struct mut

A struct value in a message.

Instances

TraverseMsg Struct

Defined in Capnp.Untyped

Methods

tMsg :: forall m (mutA :: Mutability) (mutB :: Mutability). TraverseMsgCtx m mutA mutB => (Message mutA -> m (Message mutB)) -> Struct mutA -> m (Struct mutB)

ToStruct mut (Struct mut)

Defined in Capnp.Classes

Methods

toStruct :: Struct mut -> Struct mut

FromStruct mut (Struct mut)

Defined in Capnp.Classes

Methods

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

ToPtr s (Struct ('Mut s))

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> Struct ('Mut s) -> m (Maybe (Ptr ('Mut s)))

FromPtr mut (Struct mut)

Defined in Capnp.Classes

Methods

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

ToPtr s (ListOf ('Mut s) (Struct ('Mut s)))

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> ListOf ('Mut s) (Struct ('Mut s)) -> m (Maybe (Ptr ('Mut s)))

FromPtr mut (ListOf mut (Struct mut))

Defined in Capnp.Classes

Methods

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

Thaw (Struct 'Const)

Defined in Capnp.Untyped

Associated Types

type Mutable s (Struct 'Const)

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => Struct 'Const -> m (Mutable s (Struct 'Const))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (Struct 'Const) -> m (Struct 'Const)

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => Struct 'Const -> m (Mutable s (Struct 'Const))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (Struct 'Const) -> m (Struct 'Const)

MessageDefault (Struct mut) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Struct mut)

HasMessage (Struct mut) mut

Defined in Capnp.Untyped

Methods

message :: Struct mut -> Message mut

Thaw (ListOf 'Const (Struct 'Const))

Defined in Capnp.Untyped

Associated Types

type Mutable s (ListOf 'Const (Struct 'Const))

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const (Struct 'Const) -> m (Mutable s (ListOf 'Const (Struct 'Const)))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const (Struct 'Const)) -> m (ListOf 'Const (Struct 'Const))

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const (Struct 'Const) -> m (Mutable s (ListOf 'Const (Struct 'Const)))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const (Struct 'Const)) -> m (ListOf 'Const (Struct 'Const))

MessageDefault (ListOf mut (Struct mut)) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut (Struct mut))

type Mutable s (Struct 'Const)

Defined in Capnp.Untyped

type Mutable s (Struct 'Const) = Struct ('Mut s)

type Mutable s (ListOf 'Const (Struct 'Const))

Defined in Capnp.Untyped

type Mutable s (ListOf 'Const (Struct 'Const)) = ListOf ('Mut s) (Struct ('Mut s))

type ReprFor (Struct mut)

Defined in Capnp.Repr

type ReprFor (Struct mut) = 'Ptr ('Just 'Struct)

data ListOf mut a

A list of values of type a in a message.

Instances

ToPtr s (ListOf ('Mut s) (Maybe (Ptr ('Mut s))))

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> ListOf ('Mut s) (Maybe (Ptr ('Mut s))) -> m (Maybe (Ptr ('Mut s)))

ToPtr s (ListOf ('Mut s) (Struct ('Mut s)))

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> ListOf ('Mut s) (Struct ('Mut s)) -> m (Maybe (Ptr ('Mut s)))

ToPtr s (ListOf ('Mut s) Bool)

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> ListOf ('Mut s) Bool -> m (Maybe (Ptr ('Mut s)))

ToPtr s (ListOf ('Mut s) Word64)

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> ListOf ('Mut s) Word64 -> m (Maybe (Ptr ('Mut s)))

ToPtr s (ListOf ('Mut s) Word32)

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> ListOf ('Mut s) Word32 -> m (Maybe (Ptr ('Mut s)))

ToPtr s (ListOf ('Mut s) Word16)

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> ListOf ('Mut s) Word16 -> m (Maybe (Ptr ('Mut s)))

ToPtr s (ListOf ('Mut s) Word8)

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> ListOf ('Mut s) Word8 -> m (Maybe (Ptr ('Mut s)))

ToPtr s (ListOf ('Mut s) ())

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> ListOf ('Mut s) () -> m (Maybe (Ptr ('Mut s)))

FromPtr mut (ListOf mut (Maybe (Ptr mut)))

Defined in Capnp.Classes

Methods

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

FromPtr mut (ListOf mut (Struct mut))

Defined in Capnp.Classes

Methods

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

FromPtr mut (ListOf mut Bool)

Defined in Capnp.Classes

Methods

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

FromPtr mut (ListOf mut Word64)

Defined in Capnp.Classes

Methods

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

FromPtr mut (ListOf mut Word32)

Defined in Capnp.Classes

Methods

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

FromPtr mut (ListOf mut Word16)

Defined in Capnp.Classes

Methods

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

FromPtr mut (ListOf mut Word8)

Defined in Capnp.Classes

Methods

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

FromPtr mut (ListOf mut ())

Defined in Capnp.Classes

Methods

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

Thaw (ListOf 'Const Bool)

Defined in Capnp.Untyped

Associated Types

type Mutable s (ListOf 'Const Bool)

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const Bool -> m (Mutable s (ListOf 'Const Bool))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const Bool) -> m (ListOf 'Const Bool)

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const Bool -> m (Mutable s (ListOf 'Const Bool))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const Bool) -> m (ListOf 'Const Bool)

Thaw (ListOf 'Const (Maybe (Ptr 'Const)))

Defined in Capnp.Untyped

Associated Types

type Mutable s (ListOf 'Const (Maybe (Ptr 'Const)))

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const (Maybe (Ptr 'Const)) -> m (Mutable s (ListOf 'Const (Maybe (Ptr 'Const))))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const (Maybe (Ptr 'Const))) -> m (ListOf 'Const (Maybe (Ptr 'Const)))

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const (Maybe (Ptr 'Const)) -> m (Mutable s (ListOf 'Const (Maybe (Ptr 'Const))))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const (Maybe (Ptr 'Const))) -> m (ListOf 'Const (Maybe (Ptr 'Const)))

Thaw (ListOf 'Const Word8)

Defined in Capnp.Untyped

Associated Types

type Mutable s (ListOf 'Const Word8)

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const Word8 -> m (Mutable s (ListOf 'Const Word8))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const Word8) -> m (ListOf 'Const Word8)

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const Word8 -> m (Mutable s (ListOf 'Const Word8))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const Word8) -> m (ListOf 'Const Word8)

Thaw (ListOf 'Const Word16)

Defined in Capnp.Untyped

Associated Types

type Mutable s (ListOf 'Const Word16)

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const Word16 -> m (Mutable s (ListOf 'Const Word16))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const Word16) -> m (ListOf 'Const Word16)

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const Word16 -> m (Mutable s (ListOf 'Const Word16))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const Word16) -> m (ListOf 'Const Word16)

Thaw (ListOf 'Const Word32)

Defined in Capnp.Untyped

Associated Types

type Mutable s (ListOf 'Const Word32)

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const Word32 -> m (Mutable s (ListOf 'Const Word32))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const Word32) -> m (ListOf 'Const Word32)

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const Word32 -> m (Mutable s (ListOf 'Const Word32))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const Word32) -> m (ListOf 'Const Word32)

Thaw (ListOf 'Const Word64)

Defined in Capnp.Untyped

Associated Types

type Mutable s (ListOf 'Const Word64)

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const Word64 -> m (Mutable s (ListOf 'Const Word64))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const Word64) -> m (ListOf 'Const Word64)

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const Word64 -> m (Mutable s (ListOf 'Const Word64))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const Word64) -> m (ListOf 'Const Word64)

Thaw (ListOf 'Const ())

Defined in Capnp.Untyped

Associated Types

type Mutable s (ListOf 'Const ())

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const () -> m (Mutable s (ListOf 'Const ()))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const ()) -> m (ListOf 'Const ())

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const () -> m (Mutable s (ListOf 'Const ()))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const ()) -> m (ListOf 'Const ())

Thaw (ListOf 'Const (Struct 'Const))

Defined in Capnp.Untyped

Associated Types

type Mutable s (ListOf 'Const (Struct 'Const))

Methods

thaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const (Struct 'Const) -> m (Mutable s (ListOf 'Const (Struct 'Const)))

freeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const (Struct 'Const)) -> m (ListOf 'Const (Struct 'Const))

unsafeThaw :: (PrimMonad m, PrimState m ~ s) => ListOf 'Const (Struct 'Const) -> m (Mutable s (ListOf 'Const (Struct 'Const)))

unsafeFreeze :: (PrimMonad m, PrimState m ~ s) => Mutable s (ListOf 'Const (Struct 'Const)) -> m (ListOf 'Const (Struct 'Const))

MessageDefault (ListOf mut (Maybe (Ptr mut))) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut (Maybe (Ptr mut)))

MessageDefault (ListOf mut Word64) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut Word64)

MessageDefault (ListOf mut Word32) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut Word32)

MessageDefault (ListOf mut Word16) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut Word16)

MessageDefault (ListOf mut Word8) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut Word8)

MessageDefault (ListOf mut Bool) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut Bool)

MessageDefault (ListOf mut (Struct mut)) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut (Struct mut))

MessageDefault (ListOf mut ()) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut ())

HasMessage (ListOf mut a) mut

Defined in Capnp.Untyped

Methods

message :: ListOf mut a -> Message mut

type Mutable s (ListOf 'Const (Maybe (Ptr 'Const)))

Defined in Capnp.Untyped

type Mutable s (ListOf 'Const (Maybe (Ptr 'Const))) = ListOf ('Mut s) (Maybe (Ptr ('Mut s)))

type Mutable s (ListOf 'Const (Struct 'Const))

Defined in Capnp.Untyped

type Mutable s (ListOf 'Const (Struct 'Const)) = ListOf ('Mut s) (Struct ('Mut s))

type Mutable s (ListOf 'Const Word64)

Defined in Capnp.Untyped

type Mutable s (ListOf 'Const Word64) = ListOf ('Mut s) Word64

type Mutable s (ListOf 'Const Word32)

Defined in Capnp.Untyped

type Mutable s (ListOf 'Const Word32) = ListOf ('Mut s) Word32

type Mutable s (ListOf 'Const Word16)

Defined in Capnp.Untyped

type Mutable s (ListOf 'Const Word16) = ListOf ('Mut s) Word16

type Mutable s (ListOf 'Const Word8)

Defined in Capnp.Untyped

type Mutable s (ListOf 'Const Word8) = ListOf ('Mut s) Word8

type Mutable s (ListOf 'Const Bool)

Defined in Capnp.Untyped

type Mutable s (ListOf 'Const Bool) = ListOf ('Mut s) Bool

type Mutable s (ListOf 'Const ())

Defined in Capnp.Untyped

type Mutable s (ListOf 'Const ()) = ListOf ('Mut s) ()

type ReprFor (ListOf mut a)

Defined in Capnp.Repr

type ReprFor (ListOf mut a) = ReprFor (List a)

data Cap mut

A Capability in a message.

Instances

TraverseMsg Cap

Defined in Capnp.Untyped

Methods

tMsg :: forall m (mutA :: Mutability) (mutB :: Mutability). TraverseMsgCtx m mutA mutB => (Message mutA -> m (Message mutB)) -> Cap mutA -> m (Cap mutB)

ToPtr s (Maybe (Cap ('Mut s)))

Defined in Capnp.Classes

Methods

toPtr :: WriteCtx m s => Message ('Mut s) -> Maybe (Cap ('Mut s)) -> m (Maybe (Ptr ('Mut s)))

FromPtr mut (Maybe (Cap mut))

Defined in Capnp.Classes

Methods

fromPtr :: ReadCtx m mut => Message mut -> Maybe (Ptr mut) -> m (Maybe (Cap mut))

HasMessage (Cap mut) mut

Defined in Capnp.Untyped

Methods

message :: Cap mut -> Message mut

type ReprFor (Cap mut)

Defined in Capnp.Repr

type ReprFor (Cap mut) = 'Ptr ('Just 'Cap)

structByteCount :: Struct msg -> ByteCount

Get the size (in bytes) of a struct's data section.

structWordCount :: Struct msg -> WordCount

Get the size (in words) of a struct's data section.

structPtrCount :: Struct msg -> Word16

Get the size of a struct's pointer section.

structListByteCount :: ListOf msg (Struct msg) -> ByteCount

Get the size (in words) of the data sections in a struct list.

structListWordCount :: ListOf msg (Struct msg) -> WordCount

Get the size (in words) of the data sections in a struct list.

structListPtrCount :: ListOf msg (Struct msg) -> Word16

Get the size of the pointer sections in a struct list.

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 ('Mut s), WriteCtx m s) => Word64 -> Int -> Struct ('Mut s) -> m ()

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

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

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

copyStruct :: RWCtx m s => Struct ('Mut s) -> Struct ('Mut s) -> m ()

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

copyPtr :: RWCtx m s => Message ('Mut s) -> Maybe (Ptr ('Mut s)) -> m (Maybe (Ptr ('Mut s)))

Make a copy of the value at the pointer, in the target message.

copyList :: RWCtx m s => Message ('Mut s) -> List ('Mut s) -> m (List ('Mut s))

Make a copy of the list, in the target message.

copyCap :: RWCtx m s => Message ('Mut s) -> Cap ('Mut s) -> m (Cap ('Mut s))

Make a copy of a capability inside the target message.

copyListOf :: RWCtx m s => ListOf ('Mut s) a -> ListOf ('Mut s) a -> m ()

Make a copy of the list, in the target message.

getClient :: ReadCtx m mut => Cap mut -> m Client

Extract a client (indepedent of the messsage) from the capability.

get :: ReadCtx m mut => WordPtr mut -> m (Maybe (Ptr mut))

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

index :: ReadCtx m mut => Int -> ListOf mut 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 :: RWCtx m s => a -> Int -> ListOf ('Mut 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 mut => Message mut -> m (Struct mut)

Returns the root pointer of a message.

setRoot :: WriteCtx m s => Struct ('Mut s) -> m ()

Make the given struct the root object of its message.

rawBytes :: ReadCtx m 'Const => ListOf 'Const Word8 -> m ByteString

rawBytes returns the raw bytes corresponding to the list.

type ReadCtx m mut = (MonadReadMessage mut m, MonadThrow m, MonadLimit m)

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

type RWCtx m s = (ReadCtx m ('Mut s), WriteCtx m s)

Synonym for ReadCtx + WriteCtx

class HasMessage a mut | a -> mut where

Types a whose storage is owned by a message..

Methods

message :: a -> Message mut

Get the message in which the a is stored.

Instances

HasMessage (WordPtr mut) mut

Defined in Capnp.Untyped

Methods

message :: WordPtr mut -> Message mut

HasMessage (Struct mut) mut

Defined in Capnp.Untyped

Methods

message :: Struct mut -> Message mut

HasMessage (Cap mut) mut

Defined in Capnp.Untyped

Methods

message :: Cap mut -> Message mut

HasMessage (List mut) mut

Defined in Capnp.Untyped

Methods

message :: List mut -> Message mut

HasMessage (Ptr mut) mut

Defined in Capnp.Untyped

Methods

message :: Ptr mut -> Message mut

HasMessage (StreamResult mut) mut

Defined in Capnp.Gen.Capnp.Stream

Methods

message :: StreamResult mut -> Message mut

HasMessage (CodeGeneratorRequest'RequestedFile'Import mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: CodeGeneratorRequest'RequestedFile'Import mut -> Message mut

HasMessage (CodeGeneratorRequest'RequestedFile mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: CodeGeneratorRequest'RequestedFile mut -> Message mut

HasMessage (CodeGeneratorRequest mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: CodeGeneratorRequest mut -> Message mut

HasMessage (CapnpVersion mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: CapnpVersion mut -> Message mut

HasMessage (Annotation mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Annotation mut -> Message mut

HasMessage (Value mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Value mut -> Message mut

HasMessage (Brand'Binding mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Brand'Binding mut -> Message mut

HasMessage (Brand'Scope mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Brand'Scope mut -> Message mut

HasMessage (Brand mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Brand mut -> Message mut

HasMessage (Type'anyPointer'implicitMethodParameter mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Type'anyPointer'implicitMethodParameter mut -> Message mut

HasMessage (Type'anyPointer'parameter mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Type'anyPointer'parameter mut -> Message mut

HasMessage (Type'anyPointer'unconstrained mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Type'anyPointer'unconstrained mut -> Message mut

HasMessage (Type'anyPointer mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Type'anyPointer mut -> Message mut

HasMessage (Type'interface mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Type'interface mut -> Message mut

HasMessage (Type'struct mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Type'struct mut -> Message mut

HasMessage (Type'enum mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Type'enum mut -> Message mut

HasMessage (Type'list mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Type'list mut -> Message mut

HasMessage (Type mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Type mut -> Message mut

HasMessage (Method mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Method mut -> Message mut

HasMessage (Superclass mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Superclass mut -> Message mut

HasMessage (Enumerant mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Enumerant mut -> Message mut

HasMessage (Field'ordinal mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Field'ordinal mut -> Message mut

HasMessage (Field'group mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Field'group mut -> Message mut

HasMessage (Field'slot mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Field'slot mut -> Message mut

HasMessage (Field mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Field mut -> Message mut

HasMessage (Node'SourceInfo'Member mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Node'SourceInfo'Member mut -> Message mut

HasMessage (Node'SourceInfo mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Node'SourceInfo mut -> Message mut

HasMessage (Node'NestedNode mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Node'NestedNode mut -> Message mut

HasMessage (Node'Parameter mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Node'Parameter mut -> Message mut

HasMessage (Node'annotation mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Node'annotation mut -> Message mut

HasMessage (Node'const mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Node'const mut -> Message mut

HasMessage (Node'interface mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Node'interface mut -> Message mut

HasMessage (Node'enum mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Node'enum mut -> Message mut

HasMessage (Node'struct mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Node'struct mut -> Message mut

HasMessage (Node mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

message :: Node mut -> Message mut

HasMessage (JoinResult mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

message :: JoinResult mut -> Message mut

HasMessage (JoinKeyPart mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

message :: JoinKeyPart mut -> Message mut

HasMessage (ThirdPartyCapId mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

message :: ThirdPartyCapId mut -> Message mut

HasMessage (RecipientId mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

message :: RecipientId mut -> Message mut

HasMessage (ProvisionId mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

message :: ProvisionId mut -> Message mut

HasMessage (VatId mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

message :: VatId mut -> Message mut

HasMessage (Exception mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Exception mut -> Message mut

HasMessage (ThirdPartyCapDescriptor mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: ThirdPartyCapDescriptor mut -> Message mut

HasMessage (PromisedAnswer'Op mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: PromisedAnswer'Op mut -> Message mut

HasMessage (PromisedAnswer mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: PromisedAnswer mut -> Message mut

HasMessage (CapDescriptor mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: CapDescriptor mut -> Message mut

HasMessage (Payload mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Payload mut -> Message mut

HasMessage (MessageTarget mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: MessageTarget mut -> Message mut

HasMessage (Join mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Join mut -> Message mut

HasMessage (Accept mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Accept mut -> Message mut

HasMessage (Provide mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Provide mut -> Message mut

HasMessage (Disembargo'context mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Disembargo'context mut -> Message mut

HasMessage (Disembargo mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Disembargo mut -> Message mut

HasMessage (Release mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Release mut -> Message mut

HasMessage (Resolve mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Resolve mut -> Message mut

HasMessage (Finish mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Finish mut -> Message mut

HasMessage (Return mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Return mut -> Message mut

HasMessage (Call'sendResultsTo mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Call'sendResultsTo mut -> Message mut

HasMessage (Call mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Call mut -> Message mut

HasMessage (Bootstrap mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Bootstrap mut -> Message mut

HasMessage (Message mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

message :: Message mut -> Message0 mut

HasMessage (DiscriminatorOptions mut) mut

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

message :: DiscriminatorOptions mut -> Message mut

HasMessage (FlattenOptions mut) mut

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

message :: FlattenOptions mut -> Message mut

HasMessage (Value'Call mut) mut

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

message :: Value'Call mut -> Message mut

HasMessage (Value'Field mut) mut

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

message :: Value'Field mut -> Message mut

HasMessage (Value mut) mut

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

message :: Value mut -> Message mut

HasMessage (ListOf mut a) mut

Defined in Capnp.Untyped

Methods

message :: ListOf mut a -> Message mut

HasMessage (Untyped mut (ReprFor a)) mut => HasMessage (Raw mut a) mut

Defined in Capnp.Repr

Methods

message :: Raw mut a -> Message mut

HasMessage (Persistent'SaveResults sturdyRef owner mut) mut

Defined in Capnp.Gen.Capnp.Persistent

Methods

message :: Persistent'SaveResults sturdyRef owner mut -> Message mut

HasMessage (Persistent'SaveParams sturdyRef owner mut) mut

Defined in Capnp.Gen.Capnp.Persistent

Methods

message :: Persistent'SaveParams sturdyRef owner mut -> Message mut

HasMessage (RealmGateway'export'params internalRef externalRef internalOwner externalOwner mut) mut

Defined in Capnp.Gen.Capnp.Persistent

Methods

message :: RealmGateway'export'params internalRef externalRef internalOwner externalOwner mut -> Message mut

HasMessage (RealmGateway'import'params internalRef externalRef internalOwner externalOwner mut) mut

Defined in Capnp.Gen.Capnp.Persistent

Methods

message :: RealmGateway'import'params internalRef externalRef internalOwner externalOwner mut -> Message mut

class HasMessage a mut => MessageDefault a mut 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.

Methods

messageDefault :: ReadCtx m mut => Message mut -> m a

Instances

MessageDefault (Struct mut) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Struct mut)

MessageDefault (StreamResult mut) mut

Defined in Capnp.Gen.Capnp.Stream

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (StreamResult mut)

MessageDefault (CodeGeneratorRequest'RequestedFile'Import mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (CodeGeneratorRequest'RequestedFile'Import mut)

MessageDefault (CodeGeneratorRequest'RequestedFile mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (CodeGeneratorRequest'RequestedFile mut)

MessageDefault (CodeGeneratorRequest mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (CodeGeneratorRequest mut)

MessageDefault (CapnpVersion mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (CapnpVersion mut)

MessageDefault (Annotation mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Annotation mut)

MessageDefault (Value mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Value mut)

MessageDefault (Brand'Binding mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Brand'Binding mut)

MessageDefault (Brand'Scope mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Brand'Scope mut)

MessageDefault (Brand mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Brand mut)

MessageDefault (Type'anyPointer'implicitMethodParameter mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Type'anyPointer'implicitMethodParameter mut)

MessageDefault (Type'anyPointer'parameter mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Type'anyPointer'parameter mut)

MessageDefault (Type'anyPointer'unconstrained mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Type'anyPointer'unconstrained mut)

MessageDefault (Type'anyPointer mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Type'anyPointer mut)

MessageDefault (Type'interface mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Type'interface mut)

MessageDefault (Type'struct mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Type'struct mut)

MessageDefault (Type'enum mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Type'enum mut)

MessageDefault (Type'list mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Type'list mut)

MessageDefault (Type mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Type mut)

MessageDefault (Method mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Method mut)

MessageDefault (Superclass mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Superclass mut)

MessageDefault (Enumerant mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Enumerant mut)

MessageDefault (Field'ordinal mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Field'ordinal mut)

MessageDefault (Field'group mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Field'group mut)

MessageDefault (Field'slot mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Field'slot mut)

MessageDefault (Field mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Field mut)

MessageDefault (Node'SourceInfo'Member mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Node'SourceInfo'Member mut)

MessageDefault (Node'SourceInfo mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Node'SourceInfo mut)

MessageDefault (Node'NestedNode mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Node'NestedNode mut)

MessageDefault (Node'Parameter mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Node'Parameter mut)

MessageDefault (Node'annotation mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Node'annotation mut)

MessageDefault (Node'const mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Node'const mut)

MessageDefault (Node'interface mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Node'interface mut)

MessageDefault (Node'enum mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Node'enum mut)

MessageDefault (Node'struct mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Node'struct mut)

MessageDefault (Node mut) mut

Defined in Capnp.Gen.Capnp.Schema

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Node mut)

MessageDefault (JoinResult mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (JoinResult mut)

MessageDefault (JoinKeyPart mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (JoinKeyPart mut)

MessageDefault (ThirdPartyCapId mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ThirdPartyCapId mut)

MessageDefault (RecipientId mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (RecipientId mut)

MessageDefault (ProvisionId mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ProvisionId mut)

MessageDefault (VatId mut) mut

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (VatId mut)

MessageDefault (Exception mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Exception mut)

MessageDefault (ThirdPartyCapDescriptor mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ThirdPartyCapDescriptor mut)

MessageDefault (PromisedAnswer'Op mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (PromisedAnswer'Op mut)

MessageDefault (PromisedAnswer mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (PromisedAnswer mut)

MessageDefault (CapDescriptor mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (CapDescriptor mut)

MessageDefault (Payload mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Payload mut)

MessageDefault (MessageTarget mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (MessageTarget mut)

MessageDefault (Join mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Join mut)

MessageDefault (Accept mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Accept mut)

MessageDefault (Provide mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Provide mut)

MessageDefault (Disembargo'context mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Disembargo'context mut)

MessageDefault (Disembargo mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Disembargo mut)

MessageDefault (Release mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Release mut)

MessageDefault (Resolve mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Resolve mut)

MessageDefault (Finish mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Finish mut)

MessageDefault (Return mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Return mut)

MessageDefault (Call'sendResultsTo mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Call'sendResultsTo mut)

MessageDefault (Call mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Call mut)

MessageDefault (Bootstrap mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Bootstrap mut)

MessageDefault (Message mut) mut

Defined in Capnp.Gen.Capnp.Rpc

Methods

messageDefault :: ReadCtx m mut => Message0 mut -> m (Message mut)

MessageDefault (DiscriminatorOptions mut) mut

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (DiscriminatorOptions mut)

MessageDefault (FlattenOptions mut) mut

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (FlattenOptions mut)

MessageDefault (Value'Call mut) mut

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Value'Call mut)

MessageDefault (Value'Field mut) mut

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Value'Field mut)

MessageDefault (Value mut) mut

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Value mut)

MessageDefault (ListOf mut (Maybe (Ptr mut))) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut (Maybe (Ptr mut)))

MessageDefault (ListOf mut Word64) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut Word64)

MessageDefault (ListOf mut Word32) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut Word32)

MessageDefault (ListOf mut Word16) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut Word16)

MessageDefault (ListOf mut Word8) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut Word8)

MessageDefault (ListOf mut Bool) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut Bool)

MessageDefault (ListOf mut (Struct mut)) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut (Struct mut))

MessageDefault (ListOf mut ()) mut

Defined in Capnp.Untyped

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (ListOf mut ())

MessageDefault (Untyped mut (ReprFor a)) mut => MessageDefault (Raw mut a) mut

Defined in Capnp.Repr

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Raw mut a)

MessageDefault (Persistent'SaveResults sturdyRef owner mut) mut

Defined in Capnp.Gen.Capnp.Persistent

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Persistent'SaveResults sturdyRef owner mut)

MessageDefault (Persistent'SaveParams sturdyRef owner mut) mut

Defined in Capnp.Gen.Capnp.Persistent

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (Persistent'SaveParams sturdyRef owner mut)

MessageDefault (RealmGateway'export'params internalRef externalRef internalOwner externalOwner mut) mut

Defined in Capnp.Gen.Capnp.Persistent

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (RealmGateway'export'params internalRef externalRef internalOwner externalOwner mut)

MessageDefault (RealmGateway'import'params internalRef externalRef internalOwner externalOwner mut) mut

Defined in Capnp.Gen.Capnp.Persistent

Methods

messageDefault :: ReadCtx m mut => Message mut -> m (RealmGateway'import'params internalRef externalRef internalOwner externalOwner mut)

allocStruct :: WriteCtx m s => Message ('Mut s) -> Word16 -> Word16 -> m (Struct ('Mut s))

Allocate a struct in the message.

allocCompositeList

Arguments

:: WriteCtx m s

=> Message ('Mut s)

The message to allocate in.

-> Word16

The size of the data section

-> Word16

The size of the pointer section

-> Int

The length of the list in elements.

-> m (ListOf ('Mut s) (Struct ('Mut s)))

Allocate a composite list.

allocList0 :: WriteCtx m s => Message ('Mut s) -> Int -> m (ListOf ('Mut s) ())

Allocate a list of capnproto Void values.

allocList1 :: WriteCtx m s => Message ('Mut s) -> Int -> m (ListOf ('Mut s) Bool)

Allocate a list of booleans

allocList8 :: WriteCtx m s => Message ('Mut s) -> Int -> m (ListOf ('Mut s) Word8)

Allocate a list of 8-bit values.

allocList16 :: WriteCtx m s => Message ('Mut s) -> Int -> m (ListOf ('Mut s) Word16)

Allocate a list of 16-bit values.

allocList32 :: WriteCtx m s => Message ('Mut s) -> Int -> m (ListOf ('Mut s) Word32)

Allocate a list of 32-bit values.

allocList64 :: WriteCtx m s => Message ('Mut s) -> Int -> m (ListOf ('Mut s) Word64)

Allocate a list of 64-bit words.

allocListPtr :: WriteCtx m s => Message ('Mut s) -> Int -> m (ListOf ('Mut s) (Maybe (Ptr ('Mut s))))

Allocate a list of pointers.

appendCap :: WriteCtx m s => Message ('Mut s) -> Client -> m (Cap ('Mut s))

class TraverseMsg f where

N.B. this should mostly be considered an implementation detail, but it is exposed because it is used by generated code.

TraverseMsg is similar to Traversable from the prelude, but the intent is that rather than conceptually being a "container", the instance is a value backed by a message, and the point of the type class is to be able to apply transformations to the underlying message.

We don't just use Traversable for this for two reasons:

1. While algebraically it makes sense, it would be very unintuitive to e.g. have the Traversable instance for List not traverse over the *elements* of the list.
2. For the instance for WordPtr, we actually need a stronger constraint than Applicative in order for the implementation to type check. A previous version of the library *did* have tMsg :: Applicative m => ..., but performance considerations eventually forced us to open up the hood a bit.

Methods

tMsg :: TraverseMsgCtx m mutA mutB => (Message mutA -> m (Message mutB)) -> f mutA -> m (f mutB)

Instances

TraverseMsg WordPtr

Defined in Capnp.Untyped

Methods

tMsg :: forall m (mutA :: Mutability) (mutB :: Mutability). TraverseMsgCtx m mutA mutB => (Message mutA -> m (Message mutB)) -> WordPtr mutA -> m (WordPtr mutB)

TraverseMsg Struct

Defined in Capnp.Untyped

Methods

tMsg :: forall m (mutA :: Mutability) (mutB :: Mutability). TraverseMsgCtx m mutA mutB => (Message mutA -> m (Message mutB)) -> Struct mutA -> m (Struct mutB)

TraverseMsg Cap

Defined in Capnp.Untyped

Methods

tMsg :: forall m (mutA :: Mutability) (mutB :: Mutability). TraverseMsgCtx m mutA mutB => (Message mutA -> m (Message mutB)) -> Cap mutA -> m (Cap mutB)

TraverseMsg List

Defined in Capnp.Untyped

Methods

tMsg :: forall m (mutA :: Mutability) (mutB :: Mutability). TraverseMsgCtx m mutA mutB => (Message mutA -> m (Message mutB)) -> List mutA -> m (List mutB)

TraverseMsg Ptr

Defined in Capnp.Untyped

Methods

tMsg :: forall m (mutA :: Mutability) (mutB :: Mutability). TraverseMsgCtx m mutA mutB => (Message mutA -> m (Message mutB)) -> Ptr mutA -> m (Ptr mutB)

Orphan instances

Thaw a => Thaw (Maybe a)

Associated Types

type Mutable s (Maybe a)

Methods

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

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

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

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