io-plugin
| Crates.io | io-plugin |
| lib.rs | io-plugin |
| version | 0.6.0 |
| source | src |
| created_at | 2023-12-27 03:00:20.669423 |
| updated_at | 2024-01-14 01:07:18.910175 |
| description | An stdio-based plugin system |
| homepage | https://github.com/lirannl/io-plugin |
| repository | https://github.com/lirannl/io-plugin |
| max_upload_size | |
| id | 1081353 |
| size | 6,396 |
Liran (lirannl)
documentation
README
IO-Plugin
IO-Plugin is a rust package which allows easily creating a plugin-system based on the following model:
- The host spawns instances of its' plugins (by runnning their executables)
- The host sends serialised messages on the plugin process' stdin
- The host receives serialised responses on the plugin process' stdout
Theoretically, it is also possible to create plugins in other languages, though their interfaces will have to be determined manually. The messages are currently serialised using serde-cbor (this is subject to change at my discretion - though I expect to stick to serde-supported formats).
A usage example is available under ./io-plugins-test
Checklist:
- Determine structure for translating a provided enum to the various relevant data structures.
- Write a macro that converts said enum to the data structure
- Attribute-forwarding (besides just documentation)
- Create sensible default implementations (except for the plugin-trait methods)
- Support generics (types only - no lifetimes)
- Allow providing custom default implementations (for example - to output the interface version a plugin was compiled against)
- Increase clarity of error messages (there are probably some invalid usages which result in unclear errors)