Upgrading Rinf¶

Minor Upgrades¶

Whenever upgrading Rinf, please ensure that the Rinf versions in pubspec.yaml and native/hub/Cargo.toml are identical.

Migrating from 6 to 7¶

The overall usage remains the same, but some changes have been made to the API to improve code readability and flexibility.

Explicitly bind the main function in Rust with the async runtime of your choice. Also, don’t forget to await the dart_shutdown future provided by Rinf in the main function.

Rust¶

[tokio::main]
async fn main() {
  // Do whatever you want here.
  // ...
  rinf::dart_shutdown().await;
}

Remove RINF: from Protobuf message annotations. For example, [RINF:DART-SIGNAL] should become [DART-SIGNAL].

Protobuf¶

// [DART-SIGNAL]
message SomeMessage {}

Import messages from the root generated module, not from the inner module where they are declared.

Dart¶

import 'generated.dart';

Rust¶

use crate::messages::{MyMessage, AnotherMessage};

When you need to run a Flutter web server, use rinf server to get the complete Flutter command with the necessary arguments.

CLI¶

rinf server

Migrating from 7 to 8¶

The way signal messages are used remains unchanged, but their declaration has become much cleaner. Now, we define Rust structs and annotate them with signal trait attributes. Protobuf is no longer used.

First, Rinf now requires Rust 1.85 with the 2024 edition. Run the following commands to update:

CLI¶

rustup update
rustc --version

Replace the Rinf CLI tool with the new one:

CLI¶

cargo uninstall rinf
cargo install rinf_cli

Modify your dependencies:

pubspec.yaml¶

  dependencies:
    # ...
-   rinf: ^7.0.0
-   protobuf: ^3.1.0
-   fixnum: ^1.1.0
+   rinf: ^8.0.0
+   tuple: ^2.0.2
+   meta: ^1.16.0

native/hub/Cargo.toml¶

  [dependencies]
  # ...
- rinf = "7.0.0"
- prost = "0.12.6"
+ rinf = "8.0.0"
+ serde = "1.0.219"

Move all Protobuf messages into the hub crate. Placing them inside native/hub/src/signals/mod.rs can be a good starting point, though any location within the hub crate is acceptable:

Protobuf (Before)¶

// [DART-SIGNAL]
message MessageA {}

// [RUST-SIGNAL]
message MessageB {}

message MessageC {}

Rust (After)¶

use rinf::{DartSignal, RustSignal, SignalPiece};
use serde::{Deserialize, Serialize};

#[derive(Deserialize, DartSignal)]
pub struct MessageA {}

#[derive(Serialize, RustSignal)]
pub struct MessageB {}

#[derive(SignalPiece)] // Add `Serialize` or `Deserialize` as necessary
pub struct MessageC {}

To generate the corresponding Dart code, use rinf gen instead of rinf message. After the new Dart code is generated in lib/src/bindings, you might need to manually remove the lib/messages and native/hub/src/messages directories:

CLI¶

rinf gen

Import generated classes in Dart from the bindings module:

Dart¶

- import 'package:my_app/messages/all.dart';
+ import 'package:my_app/src/bindings/bindings.dart';

The methods of signal structs are the same, but they have now become trait methods. You should explicitly import the traits to ensure the methods still work:

Rust¶

+ use rinf::{DartSignal, RustSignal};

  SomeMessage {}.send_signal_to_dart();
  let receiver = SomeMessage::get_dart_signal_receiver();

Finally, verify that your Rinf configurations in pubspec.yaml conform to the new format, if present.

CLI¶

rinf config

Don’t forget to update the .gitignore and README.md files as well!