diff options
author | Andrew Clayton <a.clayton@nginx.com> | 2023-08-29 14:03:09 +0100 |
---|---|---|
committer | Andrew Clayton <a.clayton@nginx.com> | 2023-08-29 16:39:05 +0100 |
commit | d7acf9a053c876bfedc829e2d02558881bf26cc1 (patch) | |
tree | d4b823025ce618f494d50e9fdce12625cff6ce0d | |
parent | 272bef7ffb6e014920c8de2f31fe7f9b6ab04879 (diff) | |
download | unit-wasm-d7acf9a053c876bfedc829e2d02558881bf26cc1.tar.gz unit-wasm-d7acf9a053c876bfedc829e2d02558881bf26cc1.tar.bz2 |
API-Rust.md: Add a note about luw_ vs uwr_ naming
Signed-off-by: Andrew Clayton <a.clayton@nginx.com>
Diffstat (limited to '')
-rw-r--r-- | API-Rust.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/API-Rust.md b/API-Rust.md index 565995b..7520384 100644 --- a/API-Rust.md +++ b/API-Rust.md @@ -19,7 +19,23 @@ use std::os::raw::c_char; use std::os::raw::c_void; ``` +## Naming + +You will see references to functions etc starting with *luw_* or *LUW_* and +*uwr_". + +**luw/LUW** (libunit-wasm) come from the underlying C library and in the Rust +case are the auto-generated bindings with a few manual additions. + +**uwr** (Unit Wasm Rust aka '_rusty_') is a more Rust native wrapper ontop of +the bindings. + +In _rusty_ the luw/LUW API is generally the low level stuff like the library +version macros and the various function handlers where they can be used as is +and there isn't a real need to create wrappers specifically for them. + 1. ['Rusty' Rust API](#rusty-rust-api) + * [Naming](#naming) 2. [Macros](#macros) * [Version](#version) * [String Conversion](#string-conversion) |