hexedtech/jni-toolbox
3
0
Fork 0
mirror of https://github.com/hexedtech/jni-toolbox.git synced 2024-11-25 00:44:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: updated readme

Browse source
This commit is contained in:
əlemi 2024-09-21 17:55:13 +02:00
parent 3ccb610dd5
commit 4ee1ae20d6
Signed by: alemi
GPG key ID: A4895B84D311642C
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,13 +1,19 @@
# jni-macro
this is a simple procedural macro crate to automatically generate JNI-compatible extern functions
# jni-toolbox
this is a simple crate built around [jni-rs](https://github.com/jni-rs/jni-rs) to automatically generate JNI-compatible extern functions
it also wraps functions returning `Result<>`, making short-circuiting easy
## usage
just annotate your functions with
you must implement `JniToolboxError` trait for your errors, so that they can be converted to Java errors
you will need to define classes for them, and implement `JniToolboxError` returning the class path
alternatively, an `exception` class can be specified with the `exception` attribute
then just annotate your functions with
```rust
#[jni_macro::jni(package = "your.package.path", class = "ContainerClass")]
#[jni_toolbox::jni(package = "your.package.path", class = "ContainerClass")]
fn your_function_name(arg: i32) -> Result<(), String> {
// your code here
}
@ -20,7 +26,7 @@ note that input/output arguments must be natively FFI safe: there will be no hid
## examples
the following function:
```rust
#[jni_macro::jni(package = "mp.code", class = "Client")]
#[jni_toolbox::jni(package = "mp.code", class = "Client")]
fn connect(env: JNIEnv, cacca: JString) -> Result<(), ConnectionError> {
let config = codemp::api::Config::new("asd".into(), "dsa".into());
tokio().block_on(codemp::Client::connect(config))?;