openharmony/third_party_rust_bindgen
1
0
Fork 0
mirror of https://gitee.com/openharmony/third_party_rust_bindgen synced 2024-12-13 18:27:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
c5f1c73be3
third_party_rust_bindgen/README.md

80 lines
2.5 KiB
Markdown
Raw Normal View History

Readme badges
2019-04-26 01:31:35 +00:00
[![crates.io](https://img.shields.io/crates/v/bindgen.svg)](https://crates.io/crates/bindgen)
[![docs.rs](https://docs.rs/bindgen/badge.svg)](https://docs.rs/bindgen/)
Clean up the README.md and CONTRIBUTING.md docs Use the `doctoc` program to generate tables of contents, stop referring to forking and make this the canonical `bindgen`, move the section on building to last.
2017-01-19 19:24:39 +00:00
# `bindgen`
add README and full libclang binding
2012-03-13 17:36:34 +00:00
Match tag line on github in README to downplay implied reliability of binding to C++
2018-04-03 08:05:14 +00:00
**`bindgen` automatically generates Rust FFI bindings to C (and some C++) libraries.**
add usage and example
2012-04-11 17:05:35 +00:00
11/10 MAJESTIC AF
2017-07-13 21:44:27 +00:00
For example, given the C header `doggo.h`:
add README and full libclang binding
2012-03-13 17:36:34 +00:00
Add the `bindgen` Users Guide This commit adds a Users Guide, built with [mdbook][] (the same tool used by *The Rust Book*). It moves all the user documentation from the README.md into the Users Guide. It leaves the README.md as a splash page featuring an example of what `bindgen` is and does, a link to the Users Guide, a link to the docs.rs/bindgen API reference documentation, and a link to CONTRIBUTING.md. It ensures that the Users Guide builds with `mdbook`, and all code snippets within it build as doctests and pass, on every CI run. Finally, it builds and uploads the Users Guide every time CI passes on the master branch. [mdbook]: https://github.com/azerupi/mdBook
2017-04-26 21:39:10 +00:00
```c
11/10 MAJESTIC AF
2017-07-13 21:44:27 +00:00
typedef struct Doggo {
int many;
char wow;
} Doggo;
add README and full libclang binding
2012-03-13 17:36:34 +00:00
11/10 MAJESTIC AF
2017-07-13 21:44:27 +00:00
void eleven_out_of_ten_majestic_af(Doggo* pupper);
Update README.md to reflect the current situation There are several changes: * Announce that Clang 3.9 is the new default * Update the install steps for 3.9 * Add installing steps for Windows * Update stylo's usage of bindgen
2016-12-28 02:54:17 +00:00
```
Document library usage
2016-11-15 06:01:08 +00:00
11/10 MAJESTIC AF
2017-07-13 21:44:27 +00:00
`bindgen` produces Rust FFI code allowing you to call into the `doggo` library's
Add the `bindgen` Users Guide This commit adds a Users Guide, built with [mdbook][] (the same tool used by *The Rust Book*). It moves all the user documentation from the README.md into the Users Guide. It leaves the README.md as a splash page featuring an example of what `bindgen` is and does, a link to the Users Guide, a link to the docs.rs/bindgen API reference documentation, and a link to CONTRIBUTING.md. It ensures that the Users Guide builds with `mdbook`, and all code snippets within it build as doctests and pass, on every CI run. Finally, it builds and uploads the Users Guide every time CI passes on the master branch. [mdbook]: https://github.com/azerupi/mdBook
2017-04-26 21:39:10 +00:00
functions and use its types:
Document library usage
2016-11-15 06:01:08 +00:00
```rust
Update some docs that are not changelogs
2020-06-23 12:48:42 +00:00
/* automatically generated by rust-bindgen 0.99.9 */
Document library usage
2016-11-15 06:01:08 +00:00
Add the `bindgen` Users Guide This commit adds a Users Guide, built with [mdbook][] (the same tool used by *The Rust Book*). It moves all the user documentation from the README.md into the Users Guide. It leaves the README.md as a splash page featuring an example of what `bindgen` is and does, a link to the Users Guide, a link to the docs.rs/bindgen API reference documentation, and a link to CONTRIBUTING.md. It ensures that the Users Guide builds with `mdbook`, and all code snippets within it build as doctests and pass, on every CI run. Finally, it builds and uploads the Users Guide every time CI passes on the master branch. [mdbook]: https://github.com/azerupi/mdBook
2017-04-26 21:39:10 +00:00
#[repr(C)]
11/10 MAJESTIC AF
2017-07-13 21:44:27 +00:00
pub struct Doggo {
pub many: ::std::os::raw::c_int,
pub wow: ::std::os::raw::c_char,
Document library usage
2016-11-15 06:01:08 +00:00
}
Restore links in README.md These were deleted accidentally in 073b12ff35a8ec6314d655804915f177ce453227.
2016-11-26 15:08:37 +00:00
Add the `bindgen` Users Guide This commit adds a Users Guide, built with [mdbook][] (the same tool used by *The Rust Book*). It moves all the user documentation from the README.md into the Users Guide. It leaves the README.md as a splash page featuring an example of what `bindgen` is and does, a link to the Users Guide, a link to the docs.rs/bindgen API reference documentation, and a link to CONTRIBUTING.md. It ensures that the Users Guide builds with `mdbook`, and all code snippets within it build as doctests and pass, on every CI run. Finally, it builds and uploads the Users Guide every time CI passes on the master branch. [mdbook]: https://github.com/azerupi/mdBook
2017-04-26 21:39:10 +00:00
extern "C" {
11/10 MAJESTIC AF
2017-07-13 21:44:27 +00:00
pub fn eleven_out_of_ten_majestic_af(pupper: *mut Doggo);
Add the `bindgen` Users Guide This commit adds a Users Guide, built with [mdbook][] (the same tool used by *The Rust Book*). It moves all the user documentation from the README.md into the Users Guide. It leaves the README.md as a splash page featuring an example of what `bindgen` is and does, a link to the Users Guide, a link to the docs.rs/bindgen API reference documentation, and a link to CONTRIBUTING.md. It ensures that the Users Guide builds with `mdbook`, and all code snippets within it build as doctests and pass, on every CI run. Finally, it builds and uploads the Users Guide every time CI passes on the master branch. [mdbook]: https://github.com/azerupi/mdBook
2017-04-26 21:39:10 +00:00
}
readme: Add a bit more up-to-date information.
2016-07-01 23:56:29 +00:00
```
add usage and example
2012-04-11 17:05:35 +00:00
Add the `bindgen` Users Guide This commit adds a Users Guide, built with [mdbook][] (the same tool used by *The Rust Book*). It moves all the user documentation from the README.md into the Users Guide. It leaves the README.md as a splash page featuring an example of what `bindgen` is and does, a link to the Users Guide, a link to the docs.rs/bindgen API reference documentation, and a link to CONTRIBUTING.md. It ensures that the Users Guide builds with `mdbook`, and all code snippets within it build as doctests and pass, on every CI run. Finally, it builds and uploads the Users Guide every time CI passes on the master branch. [mdbook]: https://github.com/azerupi/mdBook
2017-04-26 21:39:10 +00:00
## Users Guide
readme: Add a bit more up-to-date information.
2016-07-01 23:56:29 +00:00
Update broken links: Rust-lang-nursery => Rust-lang (#1447) * Fix broken link to user's guide * rust-lang-nursery => rust-lang * rust-lang-nusery => rust-lang
2018-11-24 14:36:57 +00:00
[📚 Read the `bindgen` users guide here! 📚](https://rust-lang.github.io/rust-bindgen)
readme: Add a bit more up-to-date information.
2016-07-01 23:56:29 +00:00
Readme/CI: mention and test the MSRV Write down the minimal supported Rust version in the README.md and add a CI test that ensures MSRV bumps cannot happen accidentally.
2020-04-26 01:00:39 +00:00
## MSRV
Bump MSRV to 1.40.0 The libloading crate is used for runtime linking and since 0.6.0 it has a MSRV of 1.40.0
2020-08-08 18:40:13 +00:00
The minimum supported Rust version is **1.40**.
Readme/CI: mention and test the MSRV Write down the minimal supported Rust version in the README.md and add a CI test that ensures MSRV bumps cannot happen accidentally.
2020-04-26 01:00:39 +00:00
No MSRV bump policy has been established yet, so MSRV may increase in any release.
Add the `bindgen` Users Guide This commit adds a Users Guide, built with [mdbook][] (the same tool used by *The Rust Book*). It moves all the user documentation from the README.md into the Users Guide. It leaves the README.md as a splash page featuring an example of what `bindgen` is and does, a link to the Users Guide, a link to the docs.rs/bindgen API reference documentation, and a link to CONTRIBUTING.md. It ensures that the Users Guide builds with `mdbook`, and all code snippets within it build as doctests and pass, on every CI run. Finally, it builds and uploads the Users Guide every time CI passes on the master branch. [mdbook]: https://github.com/azerupi/mdBook
2017-04-26 21:39:10 +00:00
## API Reference
add usage and example
2012-04-11 17:05:35 +00:00
Add the `bindgen` Users Guide This commit adds a Users Guide, built with [mdbook][] (the same tool used by *The Rust Book*). It moves all the user documentation from the README.md into the Users Guide. It leaves the README.md as a splash page featuring an example of what `bindgen` is and does, a link to the Users Guide, a link to the docs.rs/bindgen API reference documentation, and a link to CONTRIBUTING.md. It ensures that the Users Guide builds with `mdbook`, and all code snippets within it build as doctests and pass, on every CI run. Finally, it builds and uploads the Users Guide every time CI passes on the master branch. [mdbook]: https://github.com/azerupi/mdBook
2017-04-26 21:39:10 +00:00
[API reference documentation is on docs.rs](https://docs.rs/bindgen)
Update readme
2014-09-22 11:42:20 +00:00
Document environment variables in README Mention BINDGEN_EXTRA_CLANG_ARGS and clang-sys variables.
2020-06-07 19:11:23 +00:00
## Environment Variables
In addition to the [library API](https://docs.rs/bindgen) and [executable command-line API][bindgen-cmdline],
`bindgen` can be controlled through environment variables.
End-users should set these environment variables to modify `bindgen`'s behavior without modifying the source code of direct consumers of `bindgen`.
- `BINDGEN_EXTRA_CLANG_ARGS`: extra arguments to pass to `clang`
- Arguments are whitespace-separated
- Use shell-style quoting to pass through whitespace
- Examples:
- Specify alternate sysroot: `--sysroot=/path/to/sysroot`
- Add include search path with spaces: `-I"/path/with spaces"`
Additionally, `bindgen` uses `libclang` to parse C and C++ header files.
To modify how `bindgen` searches for `libclang`, see the [`clang-sys` documentation][clang-sys-env].
For more details on how `bindgen` uses `libclang`, see the [`bindgen` users guide][bindgen-book-clang].
Document that people can request releases (and I'd be more than happy to make them happen :))
2020-11-13 19:22:27 +00:00
## Releases
We don't follow a specific release calendar, but if you need a release please
file an issue requesting that (ping `@emilio` for increased effectiveness).
Add the `bindgen` Users Guide This commit adds a Users Guide, built with [mdbook][] (the same tool used by *The Rust Book*). It moves all the user documentation from the README.md into the Users Guide. It leaves the README.md as a splash page featuring an example of what `bindgen` is and does, a link to the Users Guide, a link to the docs.rs/bindgen API reference documentation, and a link to CONTRIBUTING.md. It ensures that the Users Guide builds with `mdbook`, and all code snippets within it build as doctests and pass, on every CI run. Finally, it builds and uploads the Users Guide every time CI passes on the master branch. [mdbook]: https://github.com/azerupi/mdBook
2017-04-26 21:39:10 +00:00
## Contributing
Update readme
2014-09-22 11:42:20 +00:00
Add the `bindgen` Users Guide This commit adds a Users Guide, built with [mdbook][] (the same tool used by *The Rust Book*). It moves all the user documentation from the README.md into the Users Guide. It leaves the README.md as a splash page featuring an example of what `bindgen` is and does, a link to the Users Guide, a link to the docs.rs/bindgen API reference documentation, and a link to CONTRIBUTING.md. It ensures that the Users Guide builds with `mdbook`, and all code snippets within it build as doctests and pass, on every CI run. Finally, it builds and uploads the Users Guide every time CI passes on the master branch. [mdbook]: https://github.com/azerupi/mdBook
2017-04-26 21:39:10 +00:00
[See `CONTRIBUTING.md` for hacking on `bindgen`!](./CONTRIBUTING.md)
Document environment variables in README Mention BINDGEN_EXTRA_CLANG_ARGS and clang-sys variables.
2020-06-07 19:11:23 +00:00
[bindgen-cmdline]: https://rust-lang.github.io/rust-bindgen/command-line-usage.html
[clang-sys-env]: https://github.com/KyleMayes/clang-sys#environment-variables
Update some docs that are not changelogs
2020-06-23 12:48:42 +00:00
[bindgen-book-clang]: https://rust-lang.github.io/rust-bindgen/requirements.html#clang
Reference in New Issue Copy Permalink