Capnp.New.Basics

This module contains phantom types for built-in Cap'n Proto types, analogous to the phantom types generated for structs by the code generator. It also defines applicable type class instances.

Documentation

data Text

The Cap'n Proto Text type.

Instances

AllocateList Text

Defined in Capnp.New.Basics

Associated Types

type ListAllocHint Text

Methods

newList :: RWCtx m s => ListAllocHint Text -> Message ('Mut s) -> m (Raw ('Mut s) (List Text))

Allocate Text

Defined in Capnp.New.Basics

Associated Types

type AllocHint Text

Methods

new :: RWCtx m s => AllocHint Text -> Message ('Mut s) -> m (Raw ('Mut s) Text)

EstimateListAlloc Text Text

Defined in Capnp.New.Basics

Methods

estimateListAlloc :: Vector Text0 -> AllocHint (List Text)

Parse Text Text

Defined in Capnp.New.Basics

Methods

parse :: ReadCtx m 'Const => Raw 'Const Text -> m Text0

encode :: RWCtx m s => Message ('Mut s) -> Text0 -> m (Raw ('Mut s) Text)

HasVariant "string" 'Slot Value Text

Defined in Capnp.Gen.Capnp.Compat.Json.New

Methods

variantByLabel :: Variant 'Slot Value Text

HasVariant "text" 'Slot Value Text

Defined in Capnp.Gen.Capnp.Schema.New

Methods

variantByLabel :: Variant 'Slot Value Text

HasField "displayName" 'Slot Node Text

Defined in Capnp.Gen.Capnp.Schema.New

Methods

fieldByLabel :: Field 'Slot Node Text

HasField "docComment" 'Slot Node'SourceInfo'Member Text

Defined in Capnp.Gen.Capnp.Schema.New

Methods

fieldByLabel :: Field 'Slot Node'SourceInfo'Member Text

HasField "docComment" 'Slot Node'SourceInfo Text

Defined in Capnp.Gen.Capnp.Schema.New

Methods

fieldByLabel :: Field 'Slot Node'SourceInfo Text

HasField "filename" 'Slot CodeGeneratorRequest'RequestedFile Text

Defined in Capnp.Gen.Capnp.Schema.New

Methods

fieldByLabel :: Field 'Slot CodeGeneratorRequest'RequestedFile Text

HasField "function" 'Slot Value'Call Text

Defined in Capnp.Gen.Capnp.Compat.Json.New

Methods

fieldByLabel :: Field 'Slot Value'Call Text

HasField "name" 'Slot CodeGeneratorRequest'RequestedFile'Import Text

Defined in Capnp.Gen.Capnp.Schema.New

Methods

fieldByLabel :: Field 'Slot CodeGeneratorRequest'RequestedFile'Import Text

HasField "name" 'Slot Method Text

Defined in Capnp.Gen.Capnp.Schema.New

Methods

fieldByLabel :: Field 'Slot Method Text

HasField "name" 'Slot Enumerant Text

Defined in Capnp.Gen.Capnp.Schema.New

Methods

fieldByLabel :: Field 'Slot Enumerant Text

HasField "name" 'Slot Field Text

Defined in Capnp.Gen.Capnp.Schema.New

Methods

fieldByLabel :: Field0 'Slot Field Text

HasField "name" 'Slot Node'NestedNode Text

Defined in Capnp.Gen.Capnp.Schema.New

Methods

fieldByLabel :: Field 'Slot Node'NestedNode Text

HasField "name" 'Slot Node'Parameter Text

Defined in Capnp.Gen.Capnp.Schema.New

Methods

fieldByLabel :: Field 'Slot Node'Parameter Text

HasField "name" 'Slot DiscriminatorOptions Text

Defined in Capnp.Gen.Capnp.Compat.Json.New

Methods

fieldByLabel :: Field 'Slot DiscriminatorOptions Text

HasField "name" 'Slot Value'Field Text

Defined in Capnp.Gen.Capnp.Compat.Json.New

Methods

fieldByLabel :: Field 'Slot Value'Field Text

HasField "prefix" 'Slot FlattenOptions Text

Defined in Capnp.Gen.Capnp.Compat.Json.New

Methods

fieldByLabel :: Field 'Slot FlattenOptions Text

HasField "reason" 'Slot Exception Text

Defined in Capnp.Gen.Capnp.Rpc.New

Methods

fieldByLabel :: Field 'Slot Exception Text

HasField "valueName" 'Slot DiscriminatorOptions Text

Defined in Capnp.Gen.Capnp.Compat.Json.New

Methods

fieldByLabel :: Field 'Slot DiscriminatorOptions Text

type ReprFor Text

Defined in Capnp.New.Basics

type ReprFor Text = ReprFor (List Word8)

type ListAllocHint Text

Defined in Capnp.New.Basics

type ListAllocHint Text = Int

type AllocHint Text

Defined in Capnp.New.Basics

type AllocHint Text = Int

data Data

The Cap'n Proto Data type.

Instances

AllocateList Data

Defined in Capnp.New.Basics

Associated Types

type ListAllocHint Data

Methods

newList :: RWCtx m s => ListAllocHint Data -> Message ('Mut s) -> m (Raw ('Mut s) (List Data))

Allocate Data

Defined in Capnp.New.Basics

Associated Types

type AllocHint Data

Methods

new :: RWCtx m s => AllocHint Data -> Message ('Mut s) -> m (Raw ('Mut s) Data)

EstimateListAlloc Data ByteString

Defined in Capnp.New.Basics

Methods

estimateListAlloc :: Vector ByteString -> AllocHint (List Data)

Marshal Data ByteString

Defined in Capnp.New.Basics

Methods

marshalInto :: RWCtx m s => Raw ('Mut s) Data -> ByteString -> m ()

EstimateAlloc Data ByteString

Defined in Capnp.New.Basics

Methods

estimateAlloc :: ByteString -> AllocHint Data

Parse Data ByteString

Defined in Capnp.New.Basics

Methods

parse :: ReadCtx m 'Const => Raw 'Const Data -> m ByteString

encode :: RWCtx m s => Message ('Mut s) -> ByteString -> m (Raw ('Mut s) Data)

HasVariant "data_" 'Slot Value Data

Defined in Capnp.Gen.Capnp.Schema.New

Methods

variantByLabel :: Variant 'Slot Value Data

type ReprFor Data

Defined in Capnp.New.Basics

type ReprFor Data = ReprFor (List Word8)

type ListAllocHint Data

Defined in Capnp.New.Basics

type ListAllocHint Data = Int

type AllocHint Data

Defined in Capnp.New.Basics

type AllocHint Data = Int

data AnyPointer

A Cap'n Proto AnyPointer, i.e. an arbitrary pointer with unknown schema.

Instances

AllocateList AnyPointer

Defined in Capnp.New.Basics

Associated Types

type ListAllocHint AnyPointer

Methods

newList :: RWCtx m s => ListAllocHint AnyPointer -> Message ('Mut s) -> m (Raw ('Mut s) (List AnyPointer))

HasVariant "acceptFromThirdParty" 'Slot Return AnyPointer

Defined in Capnp.Gen.Capnp.Rpc.New

Methods

variantByLabel :: Variant 'Slot Return AnyPointer

HasVariant "anyPointer" 'Slot Value AnyPointer

Defined in Capnp.Gen.Capnp.Schema.New

Methods

variantByLabel :: Variant 'Slot Value AnyPointer

HasVariant "list" 'Slot Value AnyPointer

Defined in Capnp.Gen.Capnp.Schema.New

Methods

variantByLabel :: Variant 'Slot Value AnyPointer

HasVariant "obsoleteDelete" 'Slot Message AnyPointer

Defined in Capnp.Gen.Capnp.Rpc.New

Methods

variantByLabel :: Variant 'Slot Message AnyPointer

HasVariant "obsoleteSave" 'Slot Message AnyPointer

Defined in Capnp.Gen.Capnp.Rpc.New

Methods

variantByLabel :: Variant 'Slot Message AnyPointer

HasVariant "struct" 'Slot Value AnyPointer

Defined in Capnp.Gen.Capnp.Schema.New

Methods

variantByLabel :: Variant 'Slot Value AnyPointer

HasVariant "thirdParty" 'Slot Call'sendResultsTo AnyPointer

Defined in Capnp.Gen.Capnp.Rpc.New

Methods

variantByLabel :: Variant 'Slot Call'sendResultsTo AnyPointer

HasField "cap" 'Slot JoinResult AnyPointer

Defined in Capnp.Gen.Capnp.RpcTwoparty.New

Methods

fieldByLabel :: Field 'Slot JoinResult AnyPointer

HasField "content" 'Slot Payload AnyPointer

Defined in Capnp.Gen.Capnp.Rpc.New

Methods

fieldByLabel :: Field 'Slot Payload AnyPointer

HasField "deprecatedObjectId" 'Slot Bootstrap AnyPointer

Defined in Capnp.Gen.Capnp.Rpc.New

Methods

fieldByLabel :: Field 'Slot Bootstrap AnyPointer

HasField "id" 'Slot ThirdPartyCapDescriptor AnyPointer

Defined in Capnp.Gen.Capnp.Rpc.New

Methods

fieldByLabel :: Field 'Slot ThirdPartyCapDescriptor AnyPointer

HasField "keyPart" 'Slot Join AnyPointer

Defined in Capnp.Gen.Capnp.Rpc.New

Methods

fieldByLabel :: Field 'Slot Join AnyPointer

HasField "provision" 'Slot Accept AnyPointer

Defined in Capnp.Gen.Capnp.Rpc.New

Methods

fieldByLabel :: Field 'Slot Accept AnyPointer

HasField "recipient" 'Slot Provide AnyPointer

Defined in Capnp.Gen.Capnp.Rpc.New

Methods

fieldByLabel :: Field 'Slot Provide AnyPointer

EstimateListAlloc AnyPointer (Parsed AnyPointer)

Defined in Capnp.New.Basics

Methods

estimateListAlloc :: Vector (Parsed AnyPointer) -> AllocHint (List AnyPointer)

Parse AnyPointer (Parsed AnyPointer)

Defined in Capnp.New.Basics

Methods

parse :: ReadCtx m 'Const => Raw 'Const AnyPointer -> m (Parsed AnyPointer)

encode :: RWCtx m s => Message ('Mut s) -> Parsed AnyPointer -> m (Raw ('Mut s) AnyPointer)

Eq (Parsed AnyPointer)

Defined in Capnp.New.Basics

Methods

(==) :: Parsed AnyPointer -> Parsed AnyPointer -> Bool

(/=) :: Parsed AnyPointer -> Parsed AnyPointer -> Bool

Show (Parsed AnyPointer)

Defined in Capnp.New.Basics

Methods

showsPrec :: Int -> Parsed AnyPointer -> ShowS

show :: Parsed AnyPointer -> String

showList :: [Parsed AnyPointer] -> ShowS

type ReprFor AnyPointer

Defined in Capnp.New.Basics

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

data Parsed AnyPointer

Defined in Capnp.New.Basics

data Parsed AnyPointer

• = PtrNull
• | PtrStruct (Parsed AnyStruct)
• | PtrList (Parsed AnyList)
• | PtrCap Client

type ListAllocHint AnyPointer

Defined in Capnp.New.Basics

type ListAllocHint AnyPointer = Int

data AnyList

A Cap'n Proto List with unknown element type.

Instances

Parse AnyList (Parsed AnyList)

Defined in Capnp.New.Basics

Methods

parse :: ReadCtx m 'Const => Raw 'Const AnyList -> m (Parsed AnyList)

encode :: RWCtx m s => Message ('Mut s) -> Parsed AnyList -> m (Raw ('Mut s) AnyList)

Eq (Parsed AnyList)

Defined in Capnp.New.Basics

Methods

(==) :: Parsed AnyList -> Parsed AnyList -> Bool

(/=) :: Parsed AnyList -> Parsed AnyList -> Bool

Show (Parsed AnyList)

Defined in Capnp.New.Basics

Methods

showsPrec :: Int -> Parsed AnyList -> ShowS

show :: Parsed AnyList -> String

showList :: [Parsed AnyList] -> ShowS

type ReprFor AnyList

Defined in Capnp.New.Basics

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

data Parsed AnyList

Defined in Capnp.New.Basics

data Parsed AnyList

• = ListPtr (ParsedList (Parsed AnyPointer))
• | ListStruct (ParsedList (Parsed AnyStruct))
• | List0 (ParsedList ())
• | List1 (ParsedList Bool)
• | List8 (ParsedList Word8)
• | List16 (ParsedList Word16)
• | List32 (ParsedList Word32)
• | List64 (ParsedList Word64)

data AnyStruct

A Cap'n Proto struct of unknown type.

Instances

AllocateList AnyStruct

Defined in Capnp.New.Basics

Associated Types

type ListAllocHint AnyStruct

Methods

newList :: RWCtx m s => ListAllocHint AnyStruct -> Message ('Mut s) -> m (Raw ('Mut s) (List AnyStruct))

Allocate AnyStruct

Defined in Capnp.New.Basics

Associated Types

type AllocHint AnyStruct

Methods

new :: RWCtx m s => AllocHint AnyStruct -> Message ('Mut s) -> m (Raw ('Mut s) AnyStruct)

EstimateListAlloc AnyStruct (Parsed AnyStruct)

Defined in Capnp.New.Basics

Methods

estimateListAlloc :: Vector (Parsed AnyStruct) -> AllocHint (List AnyStruct)

Marshal AnyStruct (Parsed AnyStruct)

Defined in Capnp.New.Basics

Methods

marshalInto :: RWCtx m s => Raw ('Mut s) AnyStruct -> Parsed AnyStruct -> m ()

EstimateAlloc AnyStruct (Parsed AnyStruct)

Defined in Capnp.New.Basics

Methods

estimateAlloc :: Parsed AnyStruct -> AllocHint AnyStruct

Parse AnyStruct (Parsed AnyStruct)

Defined in Capnp.New.Basics

Methods

parse :: ReadCtx m 'Const => Raw 'Const AnyStruct -> m (Parsed AnyStruct)

encode :: RWCtx m s => Message ('Mut s) -> Parsed AnyStruct -> m (Raw ('Mut s) AnyStruct)

Eq (Parsed AnyStruct)

Defined in Capnp.New.Basics

Methods

(==) :: Parsed AnyStruct -> Parsed AnyStruct -> Bool

(/=) :: Parsed AnyStruct -> Parsed AnyStruct -> Bool

Show (Parsed AnyStruct)

Defined in Capnp.New.Basics

Methods

showsPrec :: Int -> Parsed AnyStruct -> ShowS

show :: Parsed AnyStruct -> String

showList :: [Parsed AnyStruct] -> ShowS

type ReprFor AnyStruct

Defined in Capnp.New.Basics

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

data Parsed AnyStruct

Defined in Capnp.New.Basics

data Parsed AnyStruct = Struct {

• structData :: Vector Word64
• structPtrs :: Vector (Parsed AnyPointer)

}

type ListAllocHint AnyStruct

Defined in Capnp.New.Basics

type ListAllocHint AnyStruct = (Int, AllocHint 'Struct)

type AllocHint AnyStruct

Defined in Capnp.New.Basics

type AllocHint AnyStruct = (Word16, Word16)

data Capability

A Cap'n Proto capability with unknown interfaces.

Instances

Parse Capability Client

Defined in Capnp.New.Basics

Methods

parse :: ReadCtx m 'Const => Raw 'Const Capability -> m Client

encode :: RWCtx m s => Message ('Mut s) -> Client -> m (Raw ('Mut s) Capability)

type ReprFor Capability

Defined in Capnp.New.Basics

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

type ParsedList a = Vector a

Orphan instances

Parse Capability Client

Methods

parse :: ReadCtx m 'Const => Raw 'Const Capability -> m Client

encode :: RWCtx m s => Message ('Mut s) -> Client -> m (Raw ('Mut s) Capability)

Parse Data ByteString

Methods

parse :: ReadCtx m 'Const => Raw 'Const Data -> m ByteString

encode :: RWCtx m s => Message ('Mut s) -> ByteString -> m (Raw ('Mut s) Data)

Parse Text Text

Methods

parse :: ReadCtx m 'Const => Raw 'Const Text -> m Text0

encode :: RWCtx m s => Message ('Mut s) -> Text0 -> m (Raw ('Mut s) Text)