Add HarfBuzz example (#3237)

unicode-org · Apr 14, 2023 · 59e370f · 59e370f
1 parent c18a4b6
commit 59e370f
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 0 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/experimental/harfbuzz/Cargo.toml b/experimental/harfbuzz/Cargo.toml
@@ -43,6 +43,10 @@ icu_provider = { version = "1.0.0", path = "../../provider/core", features = ["m
 displaydoc = { version = "0.2.3", default-features = false }
 tinystr = { version = "0.7.1", path = "../../utils/tinystr", default-features = false }
 
+[dev-dependencies]
+icu_testdata = { path = "../../provider/testdata" }
+harfbuzz = { version = "0.4.0" }
+
 [features]
 default = []
 # TODO(#3275) Make this no_std again

diff --git a/experimental/harfbuzz/README.md b/experimental/harfbuzz/README.md
diff --git a/experimental/harfbuzz/src/lib.rs b/experimental/harfbuzz/src/lib.rs
@@ -22,6 +22,27 @@
 #![warn(missing_docs)]
 
 //! Using ICU4X as the Unicode Database back end for HarfBuzz.
+//!
+//! # Examples
+//!
+//! ```
+//! use harfbuzz::{Buffer, Direction, sys};
+//! use icu_harfbuzz::new_hb_unicode_funcs_unstable;
+//!
+//! let mut b = Buffer::with("مساء الخير");
+//!
+//! let unicode_funcs = new_hb_unicode_funcs_unstable(&icu_testdata::unstable()).unwrap();
+//!
+//! // NOTE: This currently requires `unsafe` code. For progress toward a safe abstraction, see:
+//! // <https://github.com/servo/rust-harfbuzz/pull/197>
+//! unsafe {
+//!     harfbuzz::sys::hb_buffer_set_unicode_funcs(b.as_ptr(), unicode_funcs.as_ptr());
+//! }
+//!
+//! b.guess_segment_properties();
+//! assert_eq!(b.get_direction(), Direction::RTL);
+//! assert_eq!(b.get_script(), sys::HB_SCRIPT_ARABIC);
+//! ```
 
 extern crate alloc;
 mod error;