Add a unified interface implementation for the dart class of the signal generated by `rinf gen`

[nsfoxer]

Current Status

In the generated classes now, there is a Uint8List bincodeserialize() method, and we hope to have a unified interface.

@immutable
// no mixin
class AddSyncDirMsg {
  const AddSyncDirMsg({
    required this.localDir,
    required this.tag,
  });
  Uint8List bincodeSerialize() {
      final serializer = BincodeSerializer();
      serialize(serializer);
      return serializer.bytes;
  }
//.....

Describe the Task

mixin:

// 定义一个 mixin 来约束 bincodeSerialize 方法
mixin ApiSerializable {
  Uint8List bincodeSerialize();
}

generate file:

@immutable
// having a mixin
class AddSyncDirMsg  with ApiSerializable {
  const AddSyncDirMsg({
    required this.localDir,
    required this.tag,
  });
  Uint8List bincodeSerialize() {
      final serializer = BincodeSerializer();
      serialize(serializer);
      return serializer.bytes;
  }
//.....

[temeddix]

This looks like a very good enhancement. I will apply this mechanism when I have time. Meanwhile, we are also open to PRs :)

[temeddix]

What do you think about using interface class instead of mixin like below? Interface or abstract classes can be used as type parameters, unlike mixins, which can make them better IMO.

// Written in the `rinf` Dart package

interface class DartSignal {
  void sendSignalToRust();
}

interface class RustSignal<T implements RustSignal<T>> {
  static Stream<RustSignalPack<T>> get rustSignalStream;
}

// Generated code

@immutable
class MyDartSignal implements DartSignal {
  @override
  void sendSignalToRust() {
    // ...
  }

  // ...
}

@immutable
class MyRustSignal implements RustSignal<MyRustSignal> {
  @override
  static Stream<RustSignalPack<MyRustSignal>> get rustSignalStream {
    // ...
  }

  // ...
}

Does this look suitable?

[temeddix]

I should mention that one of the biggest drawbacks is the fact that Dart cannot have static methods in interface classes or mixins:

• https://stackoverflow.com/questions/20741737/can-one-declare-a-static-method-within-an-abstract-class-in-dart

We should come up with another typing solution that can solve this problem.

[nsfoxer]

You are right. I previously understood that mixin was equivalent to interface, but it seems not to be the case. abstract class is a better choice.

Most languages do not support the constraint of static functions in interfaces. Perhaps this is because the constraint of static functions in interfaces is meaningless.

For example:
If the static method of an interface (abstract class) is available, when calling the static DartSignal deserialization(BinaryDeserializer deserializer) method of the abstract class, it is not possible to cast the parent class to a subclass.