mirror of
https://github.com/extism/extism.git
synced 2026-04-23 03:00:11 -04:00
cb55e52506
- Adds `extism-convert` crate with `ToBytes`, `FromBytes` and `FromBytesOwned` traits - This serves as a single interface for reading/writing rich types from WebAssembly linear memory. - Supports `Json` and `Msgpack` and `Protobuf` encodings out-of-the-box - Updates `Plugin::call` to take `ToBytes` as the input argument and return a `FromBytes` value - Adds `host_fn!` macro to simplify host function creation - Cleans up generated documentation a little - PR for the Rust PDK: https://github.com/extism/rust-pdk/pull/31 - Adds a `typed_plugin!` macro to implement type-safe wrappers around `Plugin` - After this we should focus on adding similar type-conversion helpers to the SDKs and other PDKs to make it easier to use across languages. For example, a Python host running a Rust plugin using Msgpack encoded types. ## Examples ### Calling a function Instead of the untyped, bytes-only `call` function: ```rust let output = plugin.call("func_name", "my data").unwrap(); let output: MyType = serde_json::from_slice(&output).unwrap(); ``` We can now use richer types to encode/decode our values directly when using `call`: ```rust let Json(output) = plugin.call::<_, Json<MyType>>("func_name", "my data").unwrap(); ``` ### Allocating inside of a host function The same interface works for host functions, so instead of: ```rust fn hello_world( plugin: &mut CurrentPlugin, inputs: &[Val], outputs: &mut [Val], _user_data: UserData, ) -> Result<(), Error> { let handle = plugin.memory_handle_val(&inputs[0])?; let input = plugin.memory_read_str(handle)?; let output = plugin.memory_alloc_bytes(&input).unwrap(); outputs[0] = output.into(); Ok(()) } ``` Becomes: ```rust fn hello_world( plugin: &mut CurrentPlugin, inputs: &[Val], outputs: &mut [Val], _user_data: UserData, ) -> Result<(), Error> { let my_value: String = plugin.memory_get_val(&inputs[0])?; let output = plugin.memory_new(&my_value)?; outputs[0] = plugin.memory_to_val(output); Ok(()) } ``` Although this isn't much of an improvement, using the `host_fn` macro, we can really begin to see how the above function is really just an identity function: ```rust host_fn!(hello_world(a: String) -> String { a }); ``` ### typed_plugin! `typed_plugin!` is used to make a typed wrapper around a Plugin: ```rust /// Create the typed plugin typed_plugin!(Testing { count_vowels(&str) -> Json<Count> }); /// Create the `Plugin` and convert it to `Testing` wrapper let mut plugin: Testing = Plugin::new(WASM, [f], true).unwrap().into(); /// Call the `count_vowels` function: let Json(output0): Json<Count> = plugin.count_vowels("abc123")?; ``` It could make sense to convert `host_fn` and/or `typed_plugin` to proc-macros at some point, but for now they work and provide some flexibility in experimenting with the interfaces. Another future update could be to figure out a nice way to make it so input can be written in multiple chunks, so the entire input doesn't have to get copied into memory at once.
164 lines
5.6 KiB
JSON
164 lines
5.6 KiB
JSON
{
|
|
"_readme": [
|
|
"This file locks the dependencies of your project to a known state",
|
|
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
|
|
"This file is @generated automatically"
|
|
],
|
|
"content-hash": "0e0352cd3a96e03fd9c964888deedb29",
|
|
"packages": [
|
|
{
|
|
"name": "ircmaxell/ffime",
|
|
"version": "dev-master",
|
|
"source": {
|
|
"type": "git",
|
|
"url": "https://github.com/ircmaxell/FFIMe.git",
|
|
"reference": "431a3c13d9906b974d50b13bf8295097ea000c5e"
|
|
},
|
|
"dist": {
|
|
"type": "zip",
|
|
"url": "https://api.github.com/repos/ircmaxell/FFIMe/zipball/431a3c13d9906b974d50b13bf8295097ea000c5e",
|
|
"reference": "431a3c13d9906b974d50b13bf8295097ea000c5e",
|
|
"shasum": ""
|
|
},
|
|
"require": {
|
|
"ircmaxell/php-c-parser": "dev-master",
|
|
"ircmaxell/php-object-symbolresolver": "dev-master",
|
|
"php": ">=8.0"
|
|
},
|
|
"require-dev": {
|
|
"phpunit/phpunit": "^8.0"
|
|
},
|
|
"default-branch": true,
|
|
"type": "library",
|
|
"autoload": {
|
|
"psr-4": {
|
|
"FFIMe\\": "lib/"
|
|
}
|
|
},
|
|
"notification-url": "https://packagist.org/downloads/",
|
|
"license": [
|
|
"MIT"
|
|
],
|
|
"authors": [
|
|
{
|
|
"name": "Anthony Ferrara",
|
|
"email": "ircmaxell@gmail.com"
|
|
}
|
|
],
|
|
"description": "Make life easy when working with 7.4's FFI",
|
|
"support": {
|
|
"issues": "https://github.com/ircmaxell/FFIMe/issues",
|
|
"source": "https://github.com/ircmaxell/FFIMe/tree/master"
|
|
},
|
|
"time": "2023-04-03T00:43:12+00:00"
|
|
},
|
|
{
|
|
"name": "ircmaxell/php-c-parser",
|
|
"version": "dev-master",
|
|
"source": {
|
|
"type": "git",
|
|
"url": "https://github.com/ircmaxell/php-c-parser.git",
|
|
"reference": "29e0223704e4ee00c66f43506f5f52db151b3517"
|
|
},
|
|
"dist": {
|
|
"type": "zip",
|
|
"url": "https://api.github.com/repos/ircmaxell/php-c-parser/zipball/29e0223704e4ee00c66f43506f5f52db151b3517",
|
|
"reference": "29e0223704e4ee00c66f43506f5f52db151b3517",
|
|
"shasum": ""
|
|
},
|
|
"require": {
|
|
"php": ">=7.4"
|
|
},
|
|
"require-dev": {
|
|
"ircmaxell/php-yacc": "dev-master",
|
|
"phpunit/phpunit": "^8.0"
|
|
},
|
|
"default-branch": true,
|
|
"type": "library",
|
|
"autoload": {
|
|
"psr-4": {
|
|
"PHPCParser\\": "lib/"
|
|
}
|
|
},
|
|
"notification-url": "https://packagist.org/downloads/",
|
|
"license": [
|
|
"MIT"
|
|
],
|
|
"authors": [
|
|
{
|
|
"name": "Anthony Ferrara",
|
|
"email": "ircmaxell@gmail.com"
|
|
},
|
|
{
|
|
"name": "Bob Weinand",
|
|
"email": "bobwei9@hotmail.com"
|
|
}
|
|
],
|
|
"description": "Parse C when using PHP",
|
|
"support": {
|
|
"issues": "https://github.com/ircmaxell/php-c-parser/issues",
|
|
"source": "https://github.com/ircmaxell/php-c-parser/tree/master"
|
|
},
|
|
"time": "2023-03-23T10:58:24+00:00"
|
|
},
|
|
{
|
|
"name": "ircmaxell/php-object-symbolresolver",
|
|
"version": "dev-master",
|
|
"source": {
|
|
"type": "git",
|
|
"url": "https://github.com/ircmaxell/php-object-symbolresolver.git",
|
|
"reference": "dfe1b1aa6c15b198bdef50fff8485e98e89f2a09"
|
|
},
|
|
"dist": {
|
|
"type": "zip",
|
|
"url": "https://api.github.com/repos/ircmaxell/php-object-symbolresolver/zipball/dfe1b1aa6c15b198bdef50fff8485e98e89f2a09",
|
|
"reference": "dfe1b1aa6c15b198bdef50fff8485e98e89f2a09",
|
|
"shasum": ""
|
|
},
|
|
"require": {
|
|
"php": ">=7.4"
|
|
},
|
|
"default-branch": true,
|
|
"type": "library",
|
|
"autoload": {
|
|
"psr-4": {
|
|
"PHPObjectSymbolResolver\\": "lib/"
|
|
}
|
|
},
|
|
"notification-url": "https://packagist.org/downloads/",
|
|
"license": [
|
|
"MIT"
|
|
],
|
|
"authors": [
|
|
{
|
|
"name": "Anthony Ferrara",
|
|
"email": "ircmaxell@gmail.com"
|
|
},
|
|
{
|
|
"name": "Bob Weinand",
|
|
"email": "bobwei9@hotmail.com"
|
|
}
|
|
],
|
|
"description": "An object file (ELF, Mach-O) parser",
|
|
"support": {
|
|
"issues": "https://github.com/ircmaxell/php-object-symbolresolver/issues",
|
|
"source": "https://github.com/ircmaxell/php-object-symbolresolver/tree/master"
|
|
},
|
|
"time": "2022-09-15T18:21:50+00:00"
|
|
}
|
|
],
|
|
"packages-dev": [],
|
|
"aliases": [],
|
|
"minimum-stability": "dev",
|
|
"stability-flags": {
|
|
"ircmaxell/ffime": 20
|
|
},
|
|
"prefer-stable": true,
|
|
"prefer-lowest": false,
|
|
"platform": {
|
|
"php": "^7.4 || ^8"
|
|
},
|
|
"platform-dev": [],
|
|
"plugin-api-version": "2.3.0"
|
|
}
|