intl/icu_capi/README.md

   1 # icu_capi [![crates.io](https://img.shields.io/crates/v/icu_capi)](https://crates.io/crates/icu_capi)
   2
   3 <!-- cargo-rdme start -->
   4
   5 This crate contains the source of truth for the [Diplomat](https://github.com/rust-diplomat/diplomat)-generated
   6 FFI bindings. This generates the C, C++, JavaScript, and TypeScript bindings. This crate also contains the `extern "C"`
   7 FFI for ICU4X.
   8
   9 While the types in this crate are public, APIs from this crate are *not intended to be used from Rust*
  10 and as such this crate may unpredictably change its Rust API across compatible semver versions. The `extern "C"` APIs exposed
  11 by this crate, while not directly documented, are stable within the same major semver version, as are the bindings exposed under
  12 the `cpp/` and `js/` folders.
  13
  14 This crate may still be explored for documentation on docs.rs, and there are generated language-specific docs available as well.
  15 C++ has sphinx docs in `cpp/docs/`, and the header files also contain documentation comments. The JS version has sphinx docs under
  16 `js/docs`, and the TypeScript sources in `js/include` are compatible with `tsdoc`.
  17
  18 This crate is `no_std` and will not typically build as a staticlib on its own. If you wish to link to it you should prefer
  19 using `icu_capi_staticlib`, or for more esoteric platforms you may write a shim crate depending on this crate that hooks in
  20 an allocator and panic hook.
  21
  22 More information on using ICU4X from C++ can be found in [our tutorial].
  23
  24 [our tutorial]: https://github.com/unicode-org/icu4x/blob/main/docs/tutorials/cpp.md
  25
  26 <!-- cargo-rdme end -->
  27
  28 ## More Information
  29
  30 For more information on development, authorship, contributing etc. please visit [`ICU4X home page`](https://github.com/unicode-org/icu4x).