Safe Haskell	Safe-Inferred
Language	Haskell2010

Capnp.Repr.Methods

Contents

Calling methods.
Orphan instances

Description

Synopsis

data Method c p r = Method {
- interfaceId :: !Word64
- methodId :: !Word16
}
class (IsCap c, IsStruct p, IsStruct r) => HasMethod (name :: Symbol) c p r | name c -> p r where
- methodByLabel :: Method c p r
newtype Pipeline a = Pipeline Pipeline
newtype Client a = Client Client
pipe :: (IsStruct a, ReprFor b ~ 'Ptr pr) => Field k a b -> Pipeline a -> Pipeline b
pipelineClient :: (IsCap a, MonadSTM m) => Pipeline a -> m (Client a)
waitPipeline :: forall a m pr. ('Ptr pr ~ ReprFor a, IsPtrRepr pr, MonadSTM m) => Pipeline a -> m (Raw a 'Const)
class AsClient f where
- asClient :: MonadSTM m => IsCap c => f c -> m (Client c)
upcast :: (AsClient f, Coercible (f p) (f c), Super p c) => f c -> f p
callB :: (AsClient f, IsCap c, IsStruct p, MonadIO m) => Method c p r -> (forall s. PureBuilder s (Raw p ('Mut s))) -> f c -> m (Pipeline r)
callR :: (AsClient f, IsCap c, IsStruct p, MonadIO m) => Method c p r -> Raw p 'Const -> f c -> m (Pipeline r)
callP :: forall c p r f m pp. (AsClient f, IsCap c, IsStruct p, Parse p pp, MonadIO m) => Method c p r -> pp -> f c -> m (Pipeline r)

Documentation

data Method c p r Source #

Represents a method on the interface type c with parameter type p and return type r.

Constructors

Method
Fields interfaceId :: !Word64 methodId :: !Word16

Instances

Instances details

HasMethod name c p r => IsLabel name (Method c p r) Source #
Instance details Defined in Capnp.Repr.Methods Methods fromLabel :: Method c p r #

class (IsCap c, IsStruct p, IsStruct r) => HasMethod (name :: Symbol) c p r | name c -> p r where Source #

An instance HasMethod name c p r indicates that the interface type c has a method named name with parameter type p and return type r. The generated code includes instances of this for each method in the schema.

Methods

methodByLabel :: Method c p r Source #

Instances

Instances details

(TypeParam sturdyRef, TypeParam owner) => HasMethod "save" (Persistent sturdyRef owner) (Persistent'SaveParams sturdyRef owner) (Persistent'SaveResults sturdyRef owner) Source #
Instance details Defined in Capnp.Gen.Capnp.Persistent Methods methodByLabel :: Method (Persistent sturdyRef owner) (Persistent'SaveParams sturdyRef owner) (Persistent'SaveResults sturdyRef owner) Source #
(TypeParam internalRef, TypeParam externalRef, TypeParam internalOwner, TypeParam externalOwner) => HasMethod "export" (RealmGateway internalRef externalRef internalOwner externalOwner) (RealmGateway'export'params internalRef externalRef internalOwner externalOwner) (Persistent'SaveResults externalRef externalOwner) Source #
Instance details Defined in Capnp.Gen.Capnp.Persistent Methods methodByLabel :: Method (RealmGateway internalRef externalRef internalOwner externalOwner) (RealmGateway'export'params internalRef externalRef internalOwner externalOwner) (Persistent'SaveResults externalRef externalOwner) Source #
(TypeParam internalRef, TypeParam externalRef, TypeParam internalOwner, TypeParam externalOwner) => HasMethod "import_" (RealmGateway internalRef externalRef internalOwner externalOwner) (RealmGateway'import'params internalRef externalRef internalOwner externalOwner) (Persistent'SaveResults internalRef internalOwner) Source #
Instance details Defined in Capnp.Gen.Capnp.Persistent Methods methodByLabel :: Method (RealmGateway internalRef externalRef internalOwner externalOwner) (RealmGateway'import'params internalRef externalRef internalOwner externalOwner) (Persistent'SaveResults internalRef internalOwner) Source #

newtype Pipeline a Source #

A Pipeline a is a reference to possibly-not-resolved result from a method call.

Constructors

Pipeline Pipeline

Instances

Instances details

AsClient Pipeline Source #
Instance details Defined in Capnp.Repr.Methods Methods asClient :: (MonadSTM m, IsCap c) => Pipeline c -> m (Client c) Source #

newtype Client a Source #

Constructors

Client Client

Instances

Instances details

AsClient Client Source #
Instance details Defined in Capnp.Repr.Methods Methods asClient :: (MonadSTM m, IsCap c) => Client c -> m (Client c) Source #
Show (Client a) Source #
Instance details Defined in Capnp.Rpc.Common Methods showsPrec :: Int -> Client a -> ShowS # show :: Client a -> String # showList :: [Client a] -> ShowS #
ReprFor a ~ 'Ptr ('Just 'Cap) => IsClient (Client a) Source #
Instance details Defined in Capnp.Repr.Methods Methods toClient :: Client a -> Client0 Source # fromClient :: Client0 -> Client a Source #
Eq (Client a) Source #
Instance details Defined in Capnp.Rpc.Common Methods (==) :: Client a -> Client a -> Bool # (/=) :: Client a -> Client a -> Bool #
(TypeParam sturdyRef, TypeParam owner) => Parse (Persistent sturdyRef owner) (Client (Persistent sturdyRef owner)) Source #
Instance details Defined in Capnp.Gen.Capnp.Persistent Methods parse :: ReadCtx m 'Const => Raw (Persistent sturdyRef owner) 'Const -> m (Client (Persistent sturdyRef owner)) Source # encode :: RWCtx m s => Message ('Mut s) -> Client (Persistent sturdyRef owner) -> m (Raw (Persistent sturdyRef owner) ('Mut s)) Source #
(TypeParam internalRef, TypeParam externalRef, TypeParam internalOwner, TypeParam externalOwner) => Parse (RealmGateway internalRef externalRef internalOwner externalOwner) (Client (RealmGateway internalRef externalRef internalOwner externalOwner)) Source #
Instance details Defined in Capnp.Gen.Capnp.Persistent Methods parse :: ReadCtx m 'Const => Raw (RealmGateway internalRef externalRef internalOwner externalOwner) 'Const -> m (Client (RealmGateway internalRef externalRef internalOwner externalOwner)) Source # encode :: RWCtx m s => Message ('Mut s) -> Client (RealmGateway internalRef externalRef internalOwner externalOwner) -> m (Raw (RealmGateway internalRef externalRef internalOwner externalOwner) ('Mut s)) Source #

pipe :: (IsStruct a, ReprFor b ~ 'Ptr pr) => Field k a b -> Pipeline a -> Pipeline b Source #

Project a pipeline to a struct onto one of its pointer fields.

pipelineClient :: (IsCap a, MonadSTM m) => Pipeline a -> m (Client a) Source #

Convert a Pipeline for a capability into a Client.

waitPipeline :: forall a m pr. ('Ptr pr ~ ReprFor a, IsPtrRepr pr, MonadSTM m) => Pipeline a -> m (Raw a 'Const) Source #

Wait for the result of a pipeline, and return its value.

class AsClient f where Source #

The AsClient class allows callers of rpc methods to abstract over Clients and Pipelines. asClient converts either of those to a client so that methods can be invoked on it.

Methods

asClient :: MonadSTM m => IsCap c => f c -> m (Client c) Source #

Instances

Instances details

AsClient Client Source #
Instance details Defined in Capnp.Repr.Methods Methods asClient :: (MonadSTM m, IsCap c) => Client c -> m (Client c) Source #
AsClient Pipeline Source #
Instance details Defined in Capnp.Repr.Methods Methods asClient :: (MonadSTM m, IsCap c) => Pipeline c -> m (Client c) Source #

upcast :: (AsClient f, Coercible (f p) (f c), Super p c) => f c -> f p Source #

Upcast is a (safe) cast from an interface to one of its superclasses.

Calling methods.

callB :: (AsClient f, IsCap c, IsStruct p, MonadIO m) => Method c p r -> (forall s. PureBuilder s (Raw p ('Mut s))) -> f c -> m (Pipeline r) Source #

Call a method. Use the provided PureBuilder to construct the parameters.

callR :: (AsClient f, IsCap c, IsStruct p, MonadIO m) => Method c p r -> Raw p 'Const -> f c -> m (Pipeline r) Source #

Call a method, supplying the parameters as a Raw struct.

callP :: forall c p r f m pp. (AsClient f, IsCap c, IsStruct p, Parse p pp, MonadIO m) => Method c p r -> pp -> f c -> m (Pipeline r) Source #

Call a method, supplying the parmaeters in parsed form.

Orphan instances

ReprFor a ~ 'Ptr ('Just 'Cap) => IsClient (Client a) Source #
Instance details Methods toClient :: Client a -> Client0 Source # fromClient :: Client0 -> Client a Source #