Capnp.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

Allocate Text

Defined in Capnp.Basics

Associated Types

type AllocHint Text

Methods

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

AllocateList Text

Defined in Capnp.Basics

Associated Types

type ListAllocHint Text

Methods

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

EstimateListAlloc Text Text

Defined in Capnp.Basics

Methods

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

Parse Text Text

Defined in Capnp.Basics

Methods

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

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

HasField "displayName" 'Slot Node Text

Defined in Capnp.Gen.Capnp.Schema

Methods

fieldByLabel :: Field 'Slot Node Text

HasField "docComment" 'Slot Node'SourceInfo Text

Defined in Capnp.Gen.Capnp.Schema

Methods

fieldByLabel :: Field 'Slot Node'SourceInfo Text

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

Defined in Capnp.Gen.Capnp.Schema

Methods

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

HasField "filename" 'Slot CodeGeneratorRequest'RequestedFile Text

Defined in Capnp.Gen.Capnp.Schema

Methods

fieldByLabel :: Field 'Slot CodeGeneratorRequest'RequestedFile Text

HasField "function" 'Slot Value'Call Text

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

fieldByLabel :: Field 'Slot Value'Call Text

HasField "name" 'Slot DiscriminatorOptions Text

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

fieldByLabel :: Field 'Slot DiscriminatorOptions Text

HasField "name" 'Slot Value'Field Text

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

fieldByLabel :: Field 'Slot Value'Field Text

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

Defined in Capnp.Gen.Capnp.Schema

Methods

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

HasField "name" 'Slot Enumerant Text

Defined in Capnp.Gen.Capnp.Schema

Methods

fieldByLabel :: Field 'Slot Enumerant Text

HasField "name" 'Slot Field Text

Defined in Capnp.Gen.Capnp.Schema

Methods

fieldByLabel :: Field0 'Slot Field Text

HasField "name" 'Slot Method Text

Defined in Capnp.Gen.Capnp.Schema

Methods

fieldByLabel :: Field 'Slot Method Text

HasField "name" 'Slot Node'NestedNode Text

Defined in Capnp.Gen.Capnp.Schema

Methods

fieldByLabel :: Field 'Slot Node'NestedNode Text

HasField "name" 'Slot Node'Parameter Text

Defined in Capnp.Gen.Capnp.Schema

Methods

fieldByLabel :: Field 'Slot Node'Parameter Text

HasField "prefix" 'Slot FlattenOptions Text

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

fieldByLabel :: Field 'Slot FlattenOptions Text

HasField "reason" 'Slot Exception Text

Defined in Capnp.Gen.Capnp.Rpc

Methods

fieldByLabel :: Field 'Slot Exception Text

HasField "valueName" 'Slot DiscriminatorOptions Text

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

fieldByLabel :: Field 'Slot DiscriminatorOptions Text

HasVariant "string" 'Slot Value Text

Defined in Capnp.Gen.Capnp.Compat.Json

Methods

variantByLabel :: Variant 'Slot Value Text

HasVariant "text" 'Slot Value Text

Defined in Capnp.Gen.Capnp.Schema

Methods

variantByLabel :: Variant 'Slot Value Text

type AllocHint Text

Defined in Capnp.Basics

type AllocHint Text = Int

type ListAllocHint Text

Defined in Capnp.Basics

type ListAllocHint Text = Int

type ReprFor Text

Defined in Capnp.Basics

type ReprFor Text = ReprFor (List Word8)

data Data

The Cap'n Proto Data type.

Instances

Allocate Data

Defined in Capnp.Basics

Associated Types

type AllocHint Data

Methods

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

AllocateList Data

Defined in Capnp.Basics

Associated Types

type ListAllocHint Data

Methods

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

EstimateAlloc Data ByteString

Defined in Capnp.Basics

Methods

estimateAlloc :: ByteString -> AllocHint Data

EstimateListAlloc Data ByteString

Defined in Capnp.Basics

Methods

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

Marshal Data ByteString

Defined in Capnp.Basics

Methods

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

Parse Data ByteString

Defined in Capnp.Basics

Methods

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

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

HasVariant "data_" 'Slot Value Data

Defined in Capnp.Gen.Capnp.Schema

Methods

variantByLabel :: Variant 'Slot Value Data

type AllocHint Data

Defined in Capnp.Basics

type AllocHint Data = Int

type ListAllocHint Data

Defined in Capnp.Basics

type ListAllocHint Data = Int

type ReprFor Data

Defined in Capnp.Basics

type ReprFor Data = ReprFor (List Word8)

data AnyPointer

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

Instances

AllocateList AnyPointer

Defined in Capnp.Basics

Associated Types

type ListAllocHint AnyPointer

Methods

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

HasField "cap" 'Slot JoinResult (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.RpcTwoparty

Methods

fieldByLabel :: Field 'Slot JoinResult (Maybe AnyPointer)

HasField "content" 'Slot Payload (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Rpc

Methods

fieldByLabel :: Field 'Slot Payload (Maybe AnyPointer)

HasField "deprecatedObjectId" 'Slot Bootstrap (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Rpc

Methods

fieldByLabel :: Field 'Slot Bootstrap (Maybe AnyPointer)

HasField "id" 'Slot ThirdPartyCapDescriptor (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Rpc

Methods

fieldByLabel :: Field 'Slot ThirdPartyCapDescriptor (Maybe AnyPointer)

HasField "keyPart" 'Slot Join (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Rpc

Methods

fieldByLabel :: Field 'Slot Join (Maybe AnyPointer)

HasField "provision" 'Slot Accept (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Rpc

Methods

fieldByLabel :: Field 'Slot Accept (Maybe AnyPointer)

HasField "recipient" 'Slot Provide (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Rpc

Methods

fieldByLabel :: Field 'Slot Provide (Maybe AnyPointer)

HasVariant "acceptFromThirdParty" 'Slot Return (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Rpc

Methods

variantByLabel :: Variant 'Slot Return (Maybe AnyPointer)

HasVariant "anyPointer" 'Slot Value (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Schema

Methods

variantByLabel :: Variant 'Slot Value (Maybe AnyPointer)

HasVariant "list" 'Slot Value (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Schema

Methods

variantByLabel :: Variant 'Slot Value (Maybe AnyPointer)

HasVariant "obsoleteDelete" 'Slot Message (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Rpc

Methods

variantByLabel :: Variant 'Slot Message (Maybe AnyPointer)

HasVariant "obsoleteSave" 'Slot Message (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Rpc

Methods

variantByLabel :: Variant 'Slot Message (Maybe AnyPointer)

HasVariant "struct" 'Slot Value (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Schema

Methods

variantByLabel :: Variant 'Slot Value (Maybe AnyPointer)

HasVariant "thirdParty" 'Slot Call'sendResultsTo (Maybe AnyPointer)

Defined in Capnp.Gen.Capnp.Rpc

Methods

variantByLabel :: Variant 'Slot Call'sendResultsTo (Maybe AnyPointer)

EstimateListAlloc AnyPointer (Parsed AnyPointer)

Defined in Capnp.Basics

Methods

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

Parse AnyPointer (Parsed AnyPointer)

Defined in Capnp.Basics

Methods

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

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

Generic (Parsed AnyPointer)

Defined in Capnp.Basics

Associated Types

type Rep (Parsed AnyPointer) :: Type -> Type

Methods

from :: Parsed AnyPointer -> Rep (Parsed AnyPointer) x

to :: Rep (Parsed AnyPointer) x -> Parsed AnyPointer

Show (Parsed AnyPointer)

Defined in Capnp.Basics

Methods

showsPrec :: Int -> Parsed AnyPointer -> ShowS

show :: Parsed AnyPointer -> String

showList :: [Parsed AnyPointer] -> ShowS

AllocateList (Maybe AnyPointer)

Defined in Capnp.Basics

Associated Types

type ListAllocHint (Maybe AnyPointer)

Methods

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

Eq (Parsed AnyPointer)

Defined in Capnp.Basics

Methods

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

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

EstimateListAlloc (Maybe AnyPointer) (Maybe (Parsed AnyPointer))

Defined in Capnp.Basics

Methods

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

Parse (Maybe AnyPointer) (Maybe (Parsed AnyPointer))

Defined in Capnp.Basics

Methods

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

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

type ListAllocHint AnyPointer

Defined in Capnp.Basics

type ListAllocHint AnyPointer = Int

data Parsed AnyPointer

Defined in Capnp.Basics

data Parsed AnyPointer

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

type ReprFor AnyPointer

Defined in Capnp.Basics

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

type Rep (Parsed AnyPointer)

Defined in Capnp.Basics

type Rep (Parsed AnyPointer) = D1 ('MetaData "Parsed" "Capnp.Basics" "capnp-0.17.0.0-KnW61yXmCDxBdeB4uIxK8L" 'False) (C1 ('MetaCons "PtrStruct" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Parsed AnyStruct))) :+: (C1 ('MetaCons "PtrList" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Parsed AnyList))) :+: C1 ('MetaCons "PtrCap" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Client))))

type ListAllocHint (Maybe AnyPointer)

Defined in Capnp.Basics

type ListAllocHint (Maybe AnyPointer) = Int

type ReprFor (Maybe AnyPointer)

Defined in Capnp.Basics

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

data AnyList

A Cap'n Proto List with unknown element type.

Instances

Parse AnyList (Parsed AnyList)

Defined in Capnp.Basics

Methods

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

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

Generic (Parsed AnyList)

Defined in Capnp.Basics

Associated Types

type Rep (Parsed AnyList) :: Type -> Type

Methods

from :: Parsed AnyList -> Rep (Parsed AnyList) x

to :: Rep (Parsed AnyList) x -> Parsed AnyList

Show (Parsed AnyList)

Defined in Capnp.Basics

Methods

showsPrec :: Int -> Parsed AnyList -> ShowS

show :: Parsed AnyList -> String

showList :: [Parsed AnyList] -> ShowS

Eq (Parsed AnyList)

Defined in Capnp.Basics

Methods

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

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

data Parsed AnyList

Defined in Capnp.Basics

data Parsed AnyList

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

type ReprFor AnyList

Defined in Capnp.Basics

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

type Rep (Parsed AnyList)

Defined in Capnp.Basics

type Rep (Parsed AnyList) = D1 ('MetaData "Parsed" "Capnp.Basics" "capnp-0.17.0.0-KnW61yXmCDxBdeB4uIxK8L" 'False) (((C1 ('MetaCons "ListPtr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParsedList (Maybe (Parsed AnyPointer))))) :+: C1 ('MetaCons "ListStruct" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParsedList (Parsed AnyStruct))))) :+: (C1 ('MetaCons "List0" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParsedList ()))) :+: C1 ('MetaCons "List1" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParsedList Bool))))) :+: ((C1 ('MetaCons "List8" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParsedList Word8))) :+: C1 ('MetaCons "List16" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParsedList Word16)))) :+: (C1 ('MetaCons "List32" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParsedList Word32))) :+: C1 ('MetaCons "List64" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ParsedList Word64))))))

data AnyStruct

A Cap'n Proto struct of unknown type.

Instances

Allocate AnyStruct

Defined in Capnp.Basics

Associated Types

type AllocHint AnyStruct

Methods

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

AllocateList AnyStruct

Defined in Capnp.Basics

Associated Types

type ListAllocHint AnyStruct

Methods

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

EstimateAlloc AnyStruct (Parsed AnyStruct)

Defined in Capnp.Basics

Methods

estimateAlloc :: Parsed AnyStruct -> AllocHint AnyStruct

EstimateListAlloc AnyStruct (Parsed AnyStruct)

Defined in Capnp.Basics

Methods

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

Marshal AnyStruct (Parsed AnyStruct)

Defined in Capnp.Basics

Methods

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

Parse AnyStruct (Parsed AnyStruct)

Defined in Capnp.Basics

Methods

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

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

Generic (Parsed AnyStruct)

Defined in Capnp.Basics

Associated Types

type Rep (Parsed AnyStruct) :: Type -> Type

Methods

from :: Parsed AnyStruct -> Rep (Parsed AnyStruct) x

to :: Rep (Parsed AnyStruct) x -> Parsed AnyStruct

Show (Parsed AnyStruct)

Defined in Capnp.Basics

Methods

showsPrec :: Int -> Parsed AnyStruct -> ShowS

show :: Parsed AnyStruct -> String

showList :: [Parsed AnyStruct] -> ShowS

Eq (Parsed AnyStruct)

Defined in Capnp.Basics

Methods

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

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

type AllocHint AnyStruct

Defined in Capnp.Basics

type AllocHint AnyStruct = (Word16, Word16)

type ListAllocHint AnyStruct

Defined in Capnp.Basics

type ListAllocHint AnyStruct = (Int, AllocHint 'Struct)

data Parsed AnyStruct

Defined in Capnp.Basics

data Parsed AnyStruct = Struct {

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

}

type ReprFor AnyStruct

Defined in Capnp.Basics

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

type Rep (Parsed AnyStruct)

Defined in Capnp.Basics

type Rep (Parsed AnyStruct) = D1 ('MetaData "Parsed" "Capnp.Basics" "capnp-0.17.0.0-KnW61yXmCDxBdeB4uIxK8L" 'False) (C1 ('MetaCons "Struct" 'PrefixI 'True) (S1 ('MetaSel ('Just "structData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Word64)) :*: S1 ('MetaSel ('Just "structPtrs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector (Maybe (Parsed AnyPointer))))))

data Capability

A Cap'n Proto capability with unknown interfaces.

Instances

Parse Capability Client

Defined in Capnp.Basics

Methods

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

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

type ReprFor Capability

Defined in Capnp.Basics

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

type ParsedList a = Vector a

textBuffer :: MonadThrow m => Raw Text mut -> m (Raw Data mut)

Return the underlying buffer containing the text. This does not include the null terminator.

textBytes :: ReadCtx m 'Const => Raw Text 'Const -> m ByteString

Convert a Text to a ByteString, comprising the raw bytes of the text (not counting the NUL terminator).

Orphan instances

Parse Capability Client

Methods

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

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

Parse Data ByteString

Methods

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

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

Parse Text Text

Methods

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

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