Merge pull request fzyzcjy#2599 from fzyzcjy/feat/12786

Update docs

Author: fzyzcjy

frb_example/flutter_package/example/pubspec.lock

@@ -297,10 +297,10 @@ packages:
     dependency: transitive
     description:
       name: web
-      sha256: cd3543bd5798f6ad290ea73d210f423502e71900302dde696f8bff84bf89a1cb
+      sha256: "868d88a33d8a87b18ffc05f9f030ba328ffefba92d6c127917a2ba740f9cfe4a"
       url: "https://pub.dev"
     source: hosted
-    version: "1.1.0"
+    version: "1.1.1"
   webdriver:
     dependency: transitive
     description:

frb_example/flutter_via_create/pubspec.lock

@@ -297,10 +297,10 @@ packages:
     dependency: transitive
     description:
       name: web
-      sha256: cd3543bd5798f6ad290ea73d210f423502e71900302dde696f8bff84bf89a1cb
+      sha256: "868d88a33d8a87b18ffc05f9f030ba328ffefba92d6c127917a2ba740f9cfe4a"
       url: "https://pub.dev"
     source: hosted
-    version: "1.1.0"
+    version: "1.1.1"
   webdriver:
     dependency: transitive
     description:

frb_example/flutter_via_integrate/pubspec.lock

@@ -297,10 +297,10 @@ packages:
     dependency: transitive
     description:
       name: web
-      sha256: cd3543bd5798f6ad290ea73d210f423502e71900302dde696f8bff84bf89a1cb
+      sha256: "868d88a33d8a87b18ffc05f9f030ba328ffefba92d6c127917a2ba740f9cfe4a"
       url: "https://pub.dev"
     source: hosted
-    version: "1.1.0"
+    version: "1.1.1"
   webdriver:
     dependency: transitive
     description:

website/docs/guides/how-to/precompiled-rust.md

@@ -0,0 +1,7 @@
+# Precompiled Rust Binaries
+
+By default, flutter_rust_bridge uses Cargokit to do Rust compilation.
+Its default mode is to compile when the users build their apps.
+
+However, if we want to ship pre-compiled Rust binaries in the Flutter package,
+this can be done by following https://github.com/irondash/cargokit/blob/main/docs/precompiled_binaries.md.

website/docs/guides/miscellaneous/codec.md

@@ -23,8 +23,12 @@ and SSE for both directions.
 
 Currently, CST+DCO is the default choice. To use SSE instead, specify `#[frb(serialize)]` to your function.
 (The attribute syntax may be changed in the future, but should be as minimal as changing the name.)
+On the other hand, if `full_dep` is false,
+i.e. users are not required to install full dependencies like LLVM in order to use flutter_rust_bridge,
+then CST+DCO codec cannot be enabled and SSE is used.
 
-For simplicity of implementation, Rust-Call-Dart uses DCO+SSE and cannot be changed currently,
+Some features are not implemented in both codecs for simplicity of implementation.
+For example, Rust-Call-Dart uses DCO+SSE and cannot be changed currently,
 but this should usually be no problem.
 If you find any difficulties due to this, feel free to create an issue.
 

website/docs/guides/third-party/manual/external-types.md

@@ -89,3 +89,71 @@ pub struct FId(pub [u8; 32]);
 #[frb(mirror(MessageId, BlobId, FeedId))]
 pub struct Id(pub [u8; 32]);
 ```
+
+## Traits
+
+Before flutter_rust_bridge supports more advanced parsing,
+traits in external third-party packages can be utilized
+through a proxy/wrapper/newtype design pattern as illustrated through the following example. 
+
+### Example
+
+In this example,
+assume there is an external crate/package called 'calc' that contains a trait by name `Calc` (and an implementation `CalcImpl`),
+and we demonstrate how to use this trait and implementation in our `flutter_rust_bridge` based package.
+
+#### External crate
+
+*<external_crate>/calc.rs* : 
+
+```rust
+pub trait Calc {
+    fn add(&self, a: u32, b: u32) -> u32;
+}
+
+pub struct CalcImpl {}
+
+impl Calc for CalcImpl {
+    fn add(&self, a: u32, b: u32) -> u32 {
+        a + b
+    }
+}
+```
+
+#### Our crate
+
+##### Scenario 1
+
+*rust/src/api/calc.rs* 
+
+```rust
+pub fn new_calc() -> Box<dyn Calc> {
+    Box::new(CalcImpl {})
+}
+```
+
+Then we get an opaque object about `Calc`, which can be passed back to Rust functions.
+
+##### Scenario 2
+
+If we want to have the methods on the `Calc` trait exposed as methods in Dart,
+one approach is to use Rust's commonly-seen proxy/wrapper/newtype design pattern as follows.
+
+*rust/src/api/calc.rs* 
+
+```rust
+// So-called "newtype" pattern
+pub struct CalcWrapper(Box<dyn Calc + Send + Sync>);
+
+impl CalcWrapper {
+    pub fn new() -> Self {
+        Self(Box::new(CalcImpl {})) // or whatever else...
+    }
+    
+    pub fn add(&self, a: u32, b: u32) -> u32 {
+        self.0.add(a, b)
+    }
+}
+```
+
+This should work now as you have an equivalent type in `dart` to use all those member methods / functions in the underlying Rust trait. 

website/docs/manual/integrate/05-template/index.md

@@ -1,5 +1,10 @@
 # Use code template to create new projects
 
+:::info
+This guide was written for flutter_rust_bridge v1, thus some content may be outdated.
+The quickest approach to integrate is to follow the one-click approach in flutter_rust_bridge's quickstart page.
+:::
+
 In this chapter, we are going to use create your own project from a code template. It seems a bit long, but it is just because we have tried to describe *every detail* that you may encounter.
 
 **Remark:** Most complexity does *not* come from this library, `flutter_rust_bridge` - it is as same complex as using raw Dart/Flutter FFI with Rust. In other words, it is the Dart/Flutter + Rust toolchain that takes time to set up.

website/docs/manual/integrate/06-existing/index.md

@@ -1,5 +1,10 @@
 # Use BrickHub to add to existing projects
 
+:::info
+This guide was written for flutter_rust_bridge v1, thus some content may be outdated.
+The quickest approach to integrate is to follow the one-click approach in flutter_rust_bridge's quickstart page.
+:::
+
 This guide is an intermediate-level introduction to integrating Rust with
 an existing Flutter project. If you are new to Rust or configuring
 build processes in general, we suggest looking at [the template tour](template/tour)

website/docs/manual/integrate/07-library/index.md

@@ -1,5 +1,10 @@
 # Creating a Dart/Flutter library with binary release
 
+:::info
+This guide was written for flutter_rust_bridge v1, thus some content may be outdated.
+The quickest approach to integrate is to follow the one-click approach in flutter_rust_bridge's quickstart page.
+:::
+
 In this chapter, we discuss how to add `flutter_rust_bridge` (FRB)
 to an already existing application or create a new application from scratch;
 this section covers creating a Dart-only library with a Flutter wrapper library on top.

website/sidebars.js

@@ -412,6 +412,7 @@ const sidebars = {
                         'guides/how-to/object-pool',
                         'guides/how-to/gitignore',
                         'guides/how-to/rust-compilation',
+                        'guides/how-to/precompiled-rust',
                         'guides/how-to/cargo-workspaces',
                         'guides/how-to/cross-origin',
                         'guides/how-to/transferable-typed-data',