README.md
1# icu_capi [](https://crates.io/crates/icu_capi)
2
3<!-- cargo-rdme start -->
4
5This crate contains the source of truth for the [Diplomat](https://github.com/rust-diplomat/diplomat)-generated
6FFI bindings. This generates the C, C++, JavaScript, and TypeScript bindings. This crate also contains the `extern "C"`
7FFI for ICU4X.
8
9While the types in this crate are public, APIs from this crate are *not intended to be used from Rust*
10and as such this crate may unpredictably change its Rust API across compatible semver versions. The `extern "C"` APIs exposed
11by this crate, while not directly documented, are stable within the same major semver version, as are the bindings exposed under
12the `cpp/` and `js/` folders.
13
14This crate may still be explored for documentation on docs.rs, and there are language-specific docs available as well.
15C++, Dart, and TypeScript headers contain inline documentation, which is available pre-rendered: [C++], [TypeScript].
16
17This crate is `no_std`-compatible. If you wish to use it in `no_std` mode, you must write a wrapper crate that defines an allocator
18and a panic hook in order to compile as a C library.
19
20More information on using ICU4X from C++ can be found in [our tutorial].
21
22[our tutorial]: https://github.com/unicode-org/icu4x/blob/main/tutorials/cpp.md
23[TypeScript]: https://unicode-org.github.io/icu4x/tsdoc
24[C++]: https://unicode-org.github.io/icu4x/cppdoc
25
26<!-- cargo-rdme end -->
27
28## More Information
29
30For more information on development, authorship, contributing etc. please visit [`ICU4X home page`](https://github.com/unicode-org/icu4x).
31