tectonic/crates/bridge_icu
rm-dr eb473ee2fc
Normalize quotes in READMEs
2024-02-13 18:37:04 -08:00
..
src crates/bridge_icu: add ICU bridge crate 2021-01-09 16:03:07 -05:00
CHANGELOG.md crates/bridge_icu: add ICU bridge crate 2021-01-09 16:03:07 -05:00
Cargo.toml crates/bridge_icu: add ICU bridge crate 2021-01-09 16:03:07 -05:00
README.md Normalize quotes in READMEs 2024-02-13 18:37:04 -08:00
build.rs bridge_icu: put the libicudata link hack here, where it belongs 2023-09-17 14:38:05 -04:00

README.md

The tectonic_bridge_icu crate

This crate is part of the Tectonic project. It exposes the C API of the ICU4C Unicode library the Rust/Cargo build framework, with no Rust bindings.

There are a variety of other low-level ICU-related crates available, with rust_icu perhaps taking the most systematic approach. This package is distinctive because:

  • It uses Tectonics dependency-finding framework, which supports both pkg-config and vcpkg.
  • It ensures the ICU C API is exposed to Cargo.
  • Because it does not need to provide Rust bindings, it avoids a good deal of grief relating to bindgen, symbol versioning, etc.

Ideally, though, one day this crate will be superseded by a true Rust "sys crate".

If your project depends on this crate, Cargo will export for your build script an environment variable named DEP_ICUUC_INCLUDE_PATH, which will be a semicolon-separated list of C include directories enabling your code to include the unicode/* headers.

You will need to ensure that your Rust code actually references this crate in order for the linker to include linked libraries. A use statement will suffice:

#[allow(unused_imports)]
#[allow(clippy::single_component_path_imports)]
use tectonic_bridge_icu;

Cargo features

At the moment this crate does not provide any Cargo features.