Struct icu::normalizer::properties::CanonicalComposition

pub struct CanonicalComposition { /* private fields */ }

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 CanonicalComposition

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.

📚 Help choosing a constructor

⚠️ The bounds on this function may change over time, including in SemVer minor releases.

Examples

let comp =
    icu_normalizer::properties::CanonicalComposition::try_new_unstable(
        &icu_testdata::unstable(),
    )
    .unwrap();

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

pub fn try_new_unstable<D>(
    data_provider: &D
) -> Result<CanonicalComposition, NormalizerError> where
    D: DataProvider<CanonicalCompositionsV1Marker> + ?Sized, 

Construct from data provider.

pub fn try_new_with_any_provider(
    provider: &impl AnyProvider
) -> Result<CanonicalComposition, NormalizerError>

Creates a new instance using an AnyProvider.

For details on the behavior of this function, see: Self::try_new_unstable

📚 Help choosing a constructor

pub fn try_new_with_buffer_provider(
    provider: &impl BufferProvider
) -> Result<CanonicalComposition, NormalizerError>

✨ Enabled with the "serde" feature.

Creates a new instance using a BufferProvider.

For details on the behavior of this function, see: Self::try_new_unstable

📚 Help choosing a constructor