Struct Jieba 

pub struct Jieba { /* private fields */ }

Jieba segmentation

Implementations

impl Jieba

pub fn empty() -> Self

Create a new instance with empty dict

pub fn new() -> Self

Create a new instance with embed dict

Requires default-dict feature to be enabled.

pub fn with_dict<R: BufRead>(dict: &mut R) -> Result<Self, Error>

Create a new instance with dict

pub fn load_default_dict(&mut self)

Loads the default dictionary into the instance.

This method reads the default dictionary from a predefined byte slice (DEFAULT_DICT) and loads it into the current instance using the load_dict method.

Arguments

• &mut self - Mutable reference to the current instance.

Requires default-dict feature to be enabled.

Examples

use jieba_rs::Jieba;

let mut instance = Jieba::empty();
instance.load_default_dict(); // Loads the default dictionary into the instance
assert!(instance.has_word("我们"), "The word '我们' should be in the dictionary after loading the default dictionary");

pub fn clear(&mut self)

Clears all data

This method performs the following actions:

1. Clears the records list, removing all entries.
2. Resets cedar to a new instance of Cedar.
3. Sets total to 0, resetting the count.

Arguments

• &mut self - Mutable reference to the current instance.

Examples

use jieba_rs::Jieba;

let mut instance = Jieba::new();
assert!(instance.has_word("我们"), "The word '我们' should be in the dictionary after loading the default dictionary");
instance.clear(); // clear all dict data
assert!(!instance.has_word("我们"), "The word '我们' should not be in the dictionary after clearing the dictionary");

pub fn add_word( &mut self, word: &str, freq: Option<usize>, tag: Option<&str>, ) -> usize

Add word to dict, return freq

freq: if None, will be given by suggest_freq

tag: if None, will be given ""

pub fn has_word(&self, word: &str) -> bool

Checks if a word exists in the dictionary.

Arguments

• word - The word to check.

Returns

• bool - Whether the word exists in the dictionary.

pub fn load_dict<R: BufRead>(&mut self, dict: &mut R) -> Result<(), Error>

Loads a dictionary by adding entries to the existing dictionary rather than resetting it.

This function reads from a BufRead source, parsing each line as a dictionary entry. Each entry is expected to contain a word, its frequency, and optionally a tag.

Type Parameters

• R: A type that implements the BufRead trait, used for reading lines from the dictionary.

Arguments

• dict - A mutable reference to a BufRead source containing the dictionary entries.

Returns

• Result<(), Error> - Returns Ok(()) if the dictionary is successfully loaded; otherwise, returns an error describing what went wrong.

Errors

This function will return an error if:

• There is an issue reading from the provided BufRead source.
• A line in the dictionary file contains invalid frequency data (not a valid integer).

pub fn suggest_freq(&self, segment: &str) -> usize

Suggest word frequency to force the characters in a word to be joined or split.

pub fn cut<'a>(&self, sentence: &'a str, hmm: bool) -> Vec<&'a str>

Cut the input text

Params

sentence: input text

hmm: enable HMM or not

pub fn cut_all<'a>(&self, sentence: &'a str) -> Vec<&'a str>

Cut the input text, return all possible words

Params

sentence: input text

pub fn cut_for_search<'a>(&self, sentence: &'a str, hmm: bool) -> Vec<&'a str>

Cut the input text in search mode

Params

sentence: input text

hmm: enable HMM or not

pub fn tokenize<'a>( &self, sentence: &'a str, mode: TokenizeMode, hmm: bool, ) -> Vec<Token<'a>>

Tokenize

Params

sentence: input text

mode: tokenize mode

hmm: enable HMM or not

pub fn tag<'a>(&'a self, sentence: &'a str, hmm: bool) -> Vec<Tag<'a>>

Tag the input text

Params

sentence: input text

hmm: enable HMM or not

Trait Implementations

impl Clone for Jieba

fn clone(&self) -> Jieba

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Jieba

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

Formats the value using the given formatter.

impl Default for Jieba

fn default() -> Self

Returns the “default value” for a type.