Moduleproto-lens-0.7.1.5Haskell2010

Data.ProtoLens.Service.Types

This module provides typeclasses for describing protobuf service metadata. It is intended to be used by library authors to generating bindings against proto services for specific RPC backends.

2 types
3 classes

Packageproto-lens-0.7.1.5
Exports5
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTypes.hs

class

class (KnownSymbol (ServiceName s), KnownSymbol (ServicePackage s), HasAllMethods s (ServiceMethods s)) => Service (s :: k) where

Metadata describing a protobuf service. The s parameter is a phantom type generated by proto-lens.

The ServiceName and ServicePackage associated type can be used to generate RPC endpoint paths.

ServiceMethods is a promoted list containing every method defined on the service. As witnessed by the HasAllMethods superclass constraint here, this type can be used to discover every instance of HasMethod available for the service.

Associated types

type family ServiceName (s :: k) :: Symbol
type family ServicePackage (s :: k) :: Symbol
type family ServiceMethods (s :: k) :: [Symbol]

Methods

packedServiceDescriptor :: Proxy s -> ByteString

classclass HasAllMethods (s :: k) (ms :: [Symbol])

Reifies the fact that there is a HasMethod instance for every symbol claimed by the ServiceMethods associated type.

Instances2HasAllMethods

HasAllMethods s '[]Defined in proto-lens-0.7.1.5 · Data.ProtoLens.Service.Types
(HasAllMethods s ms, HasMethodImpl s m) => HasAllMethods s (m ': ms)Defined in proto-lens-0.7.1.5 · Data.ProtoLens.Service.Types

class

class (KnownSymbol m, KnownSymbol (MethodName s m), Service s, Message (MethodInput s m), Message (MethodOutput s m)) => HasMethodImpl (s :: k) (m :: Symbol) where

Metadata describing a service method. The MethodInput and MethodOutput type families correspond to the Messages generated by proto-lens for the RPC as described in the protobuf.

IsClientStreaming and IsServerStreaming can be used to dispatch on library code which wishes to provide different interfaces depending on the type of streaming of the method.

Library code should use HasMethod instead of this class directly whenever the constraint will be exposed to the end user. HasMethod provides substantially friendlier error messages when used incorrectly.

Associated types

type family MethodName (s :: k) (m :: Symbol) :: Symbol
type family MethodInput (s :: k) (m :: Symbol)
type family MethodOutput (s :: k) (m :: Symbol)
type family MethodStreamingType (s :: k) (m :: Symbol) :: StreamingType

typetype HasMethod (s :: k) (m :: Symbol) = (RequireHasMethod s m (ListContains m (ServiceMethods s)), HasMethodImpl s m)

Helper constraint that expands to a user-friendly error message when m isn't actually a method provided by service s.

datadata StreamingType

Data type to be used as a promoted type for MethodStreamingType.

NonStreaming ClientStreaming ServerStreaming BiDiStreaming

Instances6Bounded, Enum, Eq, Ord, Read, Show

Bounded StreamingTypeDefined in proto-lens-0.7.1.5 · Data.ProtoLens.Service.Types
Enum StreamingTypeDefined in proto-lens-0.7.1.5 · Data.ProtoLens.Service.Types
Eq StreamingTypeDefined in proto-lens-0.7.1.5 · Data.ProtoLens.Service.Types
Ord StreamingTypeDefined in proto-lens-0.7.1.5 · Data.ProtoLens.Service.Types
Read StreamingTypeDefined in proto-lens-0.7.1.5 · Data.ProtoLens.Service.Types
Show StreamingTypeDefined in proto-lens-0.7.1.5 · Data.ProtoLens.Service.Types