| 1 |
<div align="center"> |
| 2 |
<h1><code>wit-bindgen</code></h1> |
| 3 |
|
| 4 |
<p> |
| 5 |
<strong>Guest Rust language bindings generator for |
| 6 |
<a href="https://github.com/WebAssembly/component-model/blob/main/design/mvp/WIT.md">WIT</a> |
| 7 |
and the |
| 8 |
<a href="https://github.com/WebAssembly/component-model">Component Model</a> |
| 9 |
</strong> |
| 10 |
</p> |
| 11 |
|
| 12 |
<strong>A <a href="https://bytecodealliance.org/">Bytecode Alliance</a> project</strong> |
| 13 |
|
| 14 |
<p> |
| 15 |
<img src="https://img.shields.io/badge/rustc-stable+-green.svg" alt="supported rustc stable" /> |
| 16 |
<a href="https://docs.rs/wit-bindgen"><img src="https://docs.rs/wit-bindgen/badge.svg" alt="Documentation Status" /></a> |
| 17 |
</p> |
| 18 |
</div> |
| 19 |
|
| 20 |
# About |
| 21 |
|
| 22 |
This crate provides a macro, [`generate!`], to automatically generate Rust |
| 23 |
bindings for a [WIT] [world]. For more information about this crate see the |
| 24 |
[online documentation] which includes some examples and longer form reference |
| 25 |
documentation as well. |
| 26 |
|
| 27 |
This crate is developed as a portion of the [`wit-bindgen` repository] which |
| 28 |
also contains a CLI and generators for other languages. |
| 29 |
|
| 30 |
[`generate!`]: https://docs.rs/wit-bindgen/latest/wit_bindgen/macro.generate.html |
| 31 |
[WIT]: https://component-model.bytecodealliance.org/design/wit.html |
| 32 |
[world]: https://component-model.bytecodealliance.org/design/worlds.html |
| 33 |
[online documentation]: https://docs.rs/wit-bindgen |
| 34 |
[`wit-bindgen` repository]: https://github.com/bytecodealliance/wit-bindgen |
| 35 |
|
| 36 |
# License |
| 37 |
|
| 38 |
This project is licensed under the Apache 2.0 license with the LLVM exception. |
| 39 |
See [LICENSE](LICENSE) for more details. |
| 40 |
|
| 41 |
### Contribution |
| 42 |
|
| 43 |
Unless you explicitly state otherwise, any contribution intentionally submitted |
| 44 |
for inclusion in this project by you, as defined in the Apache-2.0 license, |
| 45 |
shall be licensed as above, without any additional terms or conditions. |