// generated by diplomat-tool
import type { DataError } from "./DataError"
import type { DataProvider } from "./DataProvider"
import type { pointer, codepoint } from "./diplomat-runtime.d.ts";



/**
 * The raw canonical composition operation.
 *
 * Callers should generally use `ComposingNormalizer` unless they specifically need raw composition operations
 *
 * See the [Rust documentation for `CanonicalComposition`](https://docs.rs/icu/2.2.0/icu/normalizer/properties/struct.CanonicalComposition.html) for more information.
 */
export class CanonicalComposition {
    /** @internal */
    get ffiValue(): pointer;


    /**
     * Construct a new `CanonicalComposition` instance for NFC using a particular data source.
     *
     * See the [Rust documentation for `new`](https://docs.rs/icu/2.2.0/icu/normalizer/properties/struct.CanonicalComposition.html#method.new) for more information.
     */
    static createWithProvider(provider: DataProvider): CanonicalComposition;

    /**
     * Performs canonical composition (including Hangul) on a pair of characters
     * or returns NUL if these characters don’t compose. Composition exclusions are taken into account.
     *
     * See the [Rust documentation for `compose`](https://docs.rs/icu/2.2.0/icu/normalizer/properties/struct.CanonicalCompositionBorrowed.html#method.compose) for more information.
     */
    compose(starter: codepoint, second: codepoint): codepoint;

    /**
     * Construct a new `CanonicalComposition` instance for NFC using compiled data.
     *
     * See the [Rust documentation for `new`](https://docs.rs/icu/2.2.0/icu/normalizer/properties/struct.CanonicalComposition.html#method.new) for more information.
     */
    constructor();
}