Merge pull request #362 from cunarist/add-dart-doc-comments

Add doc comments for `DartSignal` and `RustSignal` fields

flutter_ffi_plugin/lib/src/interface.dart

@@ -10,7 +10,13 @@ typedef HandleRustSignal = void Function(int, Uint8List, Uint8List);
 /// This type is generic, and the message
 /// can be of any type declared in Protobuf.
 class RustSignal<T> {
- T message;
- Uint8List binary;
+ /// The message instance of a class generated by Protobuf.
+ final T message;
+
+ /// Binary data included in the signal.
+ /// This field is useful for sending custom bytes
+ /// without the overhead of serialization/deserialization.
+ final Uint8List binary;
+
  RustSignal(this.message, this.binary);
 }

rust_crate/src/interface.rs

@@ -10,7 +10,11 @@ use super::interface_web::*;
 /// This type is generic, and the message
 /// can be of any type declared in Protobuf.
 pub struct DartSignal<T> {
+ /// The message instance of a struct generated by Protobuf.
  pub message: T,
+ /// Binary data included in the signal.
+ /// This field is useful for sending custom bytes
+ /// without the overhead of serialization/deserialization.
  pub binary: Vec<u8>,
 }