opencc-sys 0.5.1+1.4.1

OpenCC bindings for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

type OpenCCDict = OpenCCFileDict | OpenCCInlineDict | OpenCCGroupDict;
type OpenCCSegmentation = OpenCCMmsegSegmentation | OpenCCPluginSegmentation;
type OpenCCPluginSegmentation = {
  type: string;
  resources?: Record<string, string>;
  [key: string]: string | Record<string, string> | undefined;
};

interface OpenCCConfig {
  name: string;
  normalization?: [OpenCCConversion, ...OpenCCConversion[]];
  segmentation?: OpenCCSegmentation;
  conversion_chain: [OpenCCConversion, ...OpenCCConversion[]];
}
interface OpenCCConversion {
  dict: OpenCCDict;
}
interface OpenCCFileDict {
  type: "text" | "ocd" | "ocd2";
  file: string;
  may_output_tofu?: boolean;
}
interface OpenCCInlineDict {
  type: "inline";
  entries: {
    [k: string]: string;
  };
}
interface OpenCCGroupDict {
  type: "group";
  match_policy: "short_circuit" | "union";
  dicts: [OpenCCDict, ...OpenCCDict[]];
  may_output_tofu?: boolean;
}
interface OpenCCMmsegSegmentation {
  type: "mmseg";
  dict: OpenCCDict;
}

interface OpenCCOptions {
  includeTofuRiskDictionaries?: boolean;
  configDirectory?: string;
  resourceZip?: string;
}

declare class OpenCC {
  constructor(config?: string | OpenCCConfig, options?: OpenCCOptions);
  static readonly version: string;
  static fromConfig(config: OpenCCConfig, options?: OpenCCOptions): OpenCC;
  static generateDict(inputFileName: string, outputFileName: string, formatFrom: string, formatTo: string): void;
  convert(input: string, callback: (err: string | undefined, convertedText: string) => void): void;
  convertSync(input: string): string;
  convertPromise(input: string): Promise<string>;
}

declare namespace OpenCC {
  export { OpenCC, OpenCCConfig, OpenCCOptions };
}

export = OpenCC;