ffi: implement our own export macro that always sets up the correct async runtime
#4094
Conversation
Including one that will always warn if used with async functions, and the other one always setting the tokio runtime if used for async stuff.
bnjbvr
requested review from
stefanceriu,
poljar and
Hywan
and removed request for
a team and
stefanceriu
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4094 +/- ##
==========================================
- Coverage 84.67% 84.67% -0.01%
==========================================
Files 269 269
Lines 28753 28753
==========================================
- Hits 24348 24347 -1
- Misses 4405 4406 +1 ☔ View full report in Codecov by Sentry. |
| description = "Helper macros to write FFI bindings" | ||
| edition = "2021" | ||
| homepage = "https://github.com/matrix-org/matrix-rust-sdk" | ||
| keywords = ["matrix", "chat", "messaging", "ruma"] | ||
| license = "Apache-2.0" | ||
| name = "matrix-sdk-ffi-macros" | ||
| readme = "README.md" | ||
| repository = "https://github.com/matrix-org/matrix-rust-sdk" | ||
| rust-version = { workspace = true } | ||
| version = "0.7.0" |
There was a problem hiding this comment.
We don't usually set it, or we set it to Damir. Would need to do something more general for all the crates we have :)
There was a problem hiding this comment.
like setting all to "The Rust Matrix SDK developers" or something like this
bnjbvr
force-pushed
the
bnjbvr/experiment-with-export-macro
branch
from
145910c to
327a46f
Compare
|
Dropped the second commit (since it's a bug in Clippy) and enabled auto-merge. Thanks for the quick reviews! |
| @@ -0,0 +1,24 @@ | |||
| [package] | |||
| description = "Helper macros to write FFI bindings" | |||
| edition = "2021" | |||
There was a problem hiding this comment.
@bmarty You can learn what a Rust edition is by reading https://doc.rust-lang.org/edition-guide/editions/index.html :-).
The first commit implements new macros:
matrix_sdk_ffi_macros::exportmust be used for all sync functions and impl blocks. It will complain if anything is async (the exported function or any function in the exported impl block).matrix_sdk_ffi_macros::export_asyncmust be used for async functions and impl blocks. Currently, uniffi already complains if the exported item doesn't involve async, so no code had to be added for that.The second commit prevents use of the
uniffi::exportmacro by making it into a clippy unauthorized macro, but then the local#[allow()]statement doesn't seem to be taken into account when using theuniffi::exportmacro internally :( I've opened a thread on the Rust Zulip, to ask if I've missed something by chance or not.Ways to move forward