rpc_dart_generator #

Code generator for caller/responder wrappers in rpc_dart.

• Generates Names (service + method constants, Names.instance(suffix) for multiple instances).
• Generates a final caller and an abstract responder (you implement handlers; setup() registers them).
• Codecs: by default inserts RpcCodec<T>.withDecoder(T.fromJson); if transferMode is zeroCopy no codecs/serialization checks are added.

Requirements #

• Use with build_runner (dart run build_runner build) and add it to dev_dependencies.
• Add rpc_dart_generator to dev_dependencies of the consuming package (generator is not needed at runtime).

Annotations #

• @RpcService(name, transferMode?) — declares service name and default transfer mode (auto/codec/zeroCopy).
• @RpcMethod(name, kind, requestCodec?, responseCodec?, transferMode?) — method id, RPC kind, optional codecs and per-method transfer mode.

Per-method transferMode overrides the service. In zeroCopy codecs are omitted and IRpcSerializable check is skipped. In auto/codec, if codecs are not provided, RpcCodec<T>.withDecoder(T.fromJson) is added (requires static fromJson).

Example (zero-copy, multiple instances) #

See example/lib/calculator_contract.dart and example/bin/main.dart:

responderEndpoint.registerServiceContract(
  CalculatorContractResponder(
    serviceNameOverride: CalculatorContractNames.instance('alpha'),
  ),
);
responderEndpoint.registerServiceContract(
  CalculatorContractResponder(
    serviceNameOverride: CalculatorContractNames.instance('beta'),
  ),
);

final caller = CalculatorContractCaller(
  RpcCallerEndpoint(transport: callerTransport),
  serviceNameOverride: CalculatorContractNames.instance('beta'),
);
final res = await caller.sum(SumRequest(values: [1, 2, 3]));

Example (auto codec) #

example/lib/calculator_with_codec.dart:

@RpcService(name: 'CalculatorCodec')
abstract class ICalculatorCodecContract {
  @RpcMethod(name: 'sum')
  Future<SumResponse> sum(SumRequest request, {RpcContext? context});
}

example/bin/main_codec.dart registers under Names.instance('json') and calls it.

Generate #

fvm dart pub get
fvm dart run build_runner build

Transfer modes #

• auto/codec: if codecs are absent → default RpcCodec<T>.withDecoder(T.fromJson); if provided → use them.
• zeroCopy: no codecs generated, no IRpcSerializable check (any Object), intended for zero-copy transports.

Codec/transfer matrix #

Validation #

• Signatures must match kind: unary → Future<T> func(T req, {RpcContext? context}); streams → corresponding Stream/Future.
• RpcContext is the only allowed named parameter.
• In auto/codec, types must be serializable (IRpcSerializable or primitive), otherwise generation fails.