pinyinchch

https://docs.rs/pinyinchch/0.3.0/pinyinchch/
Admin
pinyinchch is a Rust crate that provides utilities for pinyin (romanized Chinese) manipulation,...
Tokens:1,167
Snippets:13
Trust Score:9.1
Update:5 months ago
Show doc for...
Tokens:
Raw
### pinyin_split Function Signature

Source: https://docs.rs/pinyinchch/0.3.0/pinyinchch/pinyin/fn.pinyin_split.html

This function takes a string slice and returns a vector of strings representing possible pinyin splits. It aims to split as much as possible, and may yield multiple results for a single input.

```rust
pub fn pinyin_split(value: impl AsRef<str>) -> Vec<String>
```

--------------------------------

### pinyin_tokenize Function Signature

Source: https://docs.rs/pinyinchch/0.3.0/pinyinchch/pinyin/fn.pinyin_tokenize.html

This function takes a string slice or a type that can be referenced as a string slice and returns a vector of strings, representing the tokenized pinyin.

```rust
pub fn pinyin_tokenize(value: impl AsRef<str>) -> Vec<String>
```

--------------------------------

### pinyin_tokenize Function

Source: https://docs.rs/pinyinchch/0.3.0/pinyinchch/pinyin/fn.pinyin_tokenize.html

Tokenizes a given pinyin string into a vector of strings using a prefix tree.

```APIDOC
## pinyin_tokenize

### Description
借助前缀树构建的 tokenizer 来切分拼音

### Signature
```rust
pub fn pinyin_tokenize(value: impl AsRef<str>) -> Vec<String>
```

### Parameters
* **value** (impl AsRef<str>) - The input pinyin string to tokenize.

### Returns
* Vec<String> - A vector of strings representing the tokenized pinyin.
```

--------------------------------

### pinyin::pinyin_tokenize

Source: https://docs.rs/pinyinchch/0.3.0/pinyinchch/all.html

Tokenizes a Chinese string into pinyin syllables.

```APIDOC
## Function: pinyin::pinyin_tokenize

### Description
Tokenizes a Chinese string into a vector of pinyin syllables. This is a general tokenization function.

### Signature
```rust
pinyin::pinyin_tokenize(s: &str) -> Vec<String>
```

### Parameters
* `s` (*&str*) - The Chinese string to tokenize.
```

--------------------------------

### pinyin_split

Source: https://docs.rs/pinyinchch/0.3.0/pinyinchch/pinyin/fn.pinyin_split.html

Splits a string composed entirely of valid pinyin into possible combinations. Pinyin syllables are separated by spaces. The function attempts to split the input as much as possible, and may return multiple valid results.

```APIDOC
## Function pinyin_split

### Description
Splits a string of concatenated pinyin into possible valid pinyin combinations. Pinyin syllables are separated by spaces. The function attempts to split the input as much as possible, and may return multiple valid results.

Examples:
- `jinan` => `["ji nan", "jin an"]`
- `zhang` => `["zhang"]`
- `zhangssan` => `[]`

### Signature
```rust
pub fn pinyin_split(value: impl AsRef<str>) -> Vec<String>
```

### Parameters
* `value` - A string slice that is expected to be a concatenation of valid pinyin.

### Returns
A vector of strings, where each string represents a possible valid split of the input pinyin.

### Algorithm Source
https://github.com/xmflswood/pinyin-match/blob/master/src/core.js#L57
```

--------------------------------

### pinyin::pinyin_split

Source: https://docs.rs/pinyinchch/0.3.0/pinyinchch/all.html

Splits a Chinese string into pinyin syllables.

```APIDOC
## Function: pinyin::pinyin_split

### Description
Splits a Chinese string into a vector of pinyin syllables.

### Signature
```rust
pinyin::pinyin_split(s: &str) -> Vec<String>
```

### Parameters
* `s` (*&str*) - The Chinese string to split.
```

--------------------------------

### pinyin::pinyin_split_by_trie_tokenizer

Source: https://docs.rs/pinyinchch/0.3.0/pinyinchch/all.html

Splits a Chinese string into pinyin syllables using a Trie tokenizer.

```APIDOC
## Function: pinyin::pinyin_split_by_trie_tokenizer

### Description
Splits a Chinese string into a vector of pinyin syllables using a Trie-based tokenizer for potentially more accurate segmentation.

### Signature
```rust
pinyin::pinyin_split_by_trie_tokenizer(s: &str) -> Vec<String>
```

### Parameters
* `s` (*&str*) - The Chinese string to split.
```

--------------------------------

### pinyin_split_by_trie_tokenizer

Source: https://docs.rs/pinyinchch/0.3.0/pinyinchch/pinyin/fn.pinyin_split_by_trie_tokenizer.html

Splits a given pinyin string into its constituent parts using a Trie-based tokenizer. This function is useful for accurately segmenting pinyin sequences, especially in contexts where multiple valid segmentations might exist.

```APIDOC
## Function pinyin_split_by_trie_tokenizer

### Description
Splits a pinyin string into its components using a Trie-based tokenizer.

### Signature
```rust
pub fn pinyin_split_by_trie_tokenizer(value: impl AsRef<str>) -> String
```

### Parameters
* `value` (impl AsRef<str>): The input pinyin string to be tokenized. It can be a string slice or any type that can be referenced as a string.

### Returns
* `String`: A string representing the tokenized pinyin. The exact format of the output string depends on the internal implementation of the tokenizer.
```
Tokens:
Raw