toad/toad-java
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix glue docs

Browse Source
This commit is contained in:
Orion Kindel 2023-04-05 10:26:55 -07:00
parent 4a64f116dc
commit 336849a058
Signed by untrusted user who does not match committer: orion
GPG Key ID: 6D4165AE4C928719
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
glue/README.md
View File

@ -2,6 +2,10 @@
Implementations of native java methods and state for Implementations of native java methods and state for
running `toad` with the JVM running `toad` with the JVM
### nightly
this project builds on the nightly channel so that it can
use the pointer strict provenance API (explained in [# pub static mut RUNTIME](#pub-static-mut-runtime))
### integers ### integers
all integers stored in java objects to be passed to rust code all integers stored in java objects to be passed to rust code
should use the `dev.toad.ffi.uX` compat classes to ensure should use the `dev.toad.ffi.uX` compat classes to ensure
@ -9,10 +13,10 @@ that the primitive casts in rust succeed.
### unsafe ### unsafe
#### justification #### justification
aside from the [runtime](#pub-static-mut-runtime), all usage of with 1 exception described below in [# pub static mut RUNTIME](#pub-static-mut-runtime),
unsafe in safe functions is accompanied by a `// SAFETY` comment all uses of `unsafe` in safe functions are accompanied
justifying its use and explaining the risks (or not) of memory defects by a `// SAFETY` comment justifying its use and explaining
and UB. the risks (or not) of memory defects and UB.
#### pub static mut RUNTIME #### pub static mut RUNTIME
`unsafe` is used in an **unjustified** manner to cast `long` addresses `unsafe` is used in an **unjustified** manner to cast `long` addresses