Struct icu_normalizer::properties::CanonicalCompositionBorrowed

pub struct CanonicalCompositionBorrowed<'a> { /* private fields */ }

Borrowed version of the raw canonical composition operation.

Callers should generally use ComposingNormalizer instead of this API. However, this API is provided for callers such as HarfBuzz that specifically want access to the raw canonical composition operation e.g. for use in a glyph-availability-guided custom normalizer.

Implementations

impl CanonicalCompositionBorrowed<'static>

pub const fn static_to_owned(self) -> CanonicalComposition

Cheaply converts a [CanonicalCompositionBorrowed<'static>] into a CanonicalComposition.

Note: Due to branching and indirection, using CanonicalComposition might inhibit some compile-time optimizations that are possible with CanonicalCompositionBorrowed.

pub const fn new() -> Self

Constructs a new CanonicalComposition using compiled data.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

impl CanonicalCompositionBorrowed<'_>

pub fn compose(&self, starter: char, second: char) -> Option<char>

Performs canonical composition (including Hangul) on a pair of characters or returns None if these characters don’t compose. Composition exclusions are taken into account.

Examples

let comp = icu::normalizer::properties::CanonicalCompositionBorrowed::new();

assert_eq!(comp.compose('a', 'b'), None); // Just two non-composing starters
assert_eq!(comp.compose('a', '\u{0308}'), Some('ä'));
assert_eq!(comp.compose('ẹ', '\u{0302}'), Some('ệ'));
assert_eq!(comp.compose('𝅗', '𝅥'), None); // Composition exclusion
assert_eq!(comp.compose('ে', 'া'), Some('ো')); // Second is starter
assert_eq!(comp.compose('ᄀ', 'ᅡ'), Some('가')); // Hangul LV
assert_eq!(comp.compose('가', 'ᆨ'), Some('각')); // Hangul LVT

Trait Implementations

impl<'a> Debug for CanonicalCompositionBorrowed<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CanonicalCompositionBorrowed<'static>

fn default() -> Self

Returns the “default value” for a type.