Skip to content

Commit

Permalink
Update docs and CI
Browse files Browse the repository at this point in the history
  • Loading branch information
temeddix committed Sep 12, 2024
1 parent ff16a5f commit 3f9c30d
Show file tree
Hide file tree
Showing 3 changed files with 1 addition and 18 deletions.
1 change: 0 additions & 1 deletion .github/workflows/quality_control.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ jobs:
- name: Fetch Flutter dependencies
run: |
flutter pub get --directory flutter_ffi_plugin/
flutter pub get --directory flutter_ffi_plugin/cargokit/build_tool
- name: Generate message files
working-directory: flutter_ffi_plugin/example/
Expand Down
16 changes: 0 additions & 16 deletions documentation/docs/frequently-asked-questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,22 +54,6 @@ No, the updated Rust code cannot be loaded upon Dart's hot restart. To incorpora

On native platforms, Dart's hot restart makes the Rust logic restart, in other words, the `async fn main()` function. On the web, Dart's hot restart has no effect on the Rust logic, because it's not possible to cancel all the async tasks that are already queued inside the JavaScript event loop.

### How do I use nightly Rust?

In order to use nightly Rust, you need to add a cargokit configuration file. Cargokit is the build connector between Dart and Rust used by this framework.

```yaml title="native/hub/cargokit.yaml"
cargo:
debug:
toolchain: nightly
release:
toolchain: nightly
```
More information about `cargokit.yaml` can be found at the link below. Cargokit is the linker for Rust crates that are used in various Flutter projects, including Rinf.

- https://github.com/irondash/cargokit/blob/main/docs/architecture.md

### Is it safe enough to pass secret parameters between Dart and Rust?

It is safe to pass secret parameters between Dart and Rust. Some other Rust GUI frameworks use HTTP or websockets to communicate between GUI and Rust, which is quite insecure. However, that's not the case for Rinf because messages are passed within the Flutter app's process. Please note that while it is hard to reverse-engineer compiled native binaries to search for secret keys or params, it is generally not recommended to hardcode sensitive information in the application itself. This caution applies to this framework as well as any other distributed binaries.
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/running-and-building.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The following commands are just enough to run and build apps for native platforms. It's that simple.[^1]

[^1]: Rinf builds the native Rust library and links it to the Flutter app using [Cargokit](https://github.com/irondash/cargokit).
[^1]: Rinf builds the native Rust library and links it to the Flutter app using [`native_toolchain_rust`](https://pub.dev/packages/native_toolchain_rust).

To run the app:

Expand Down

0 comments on commit 3f9c30d

Please sign in to comment.