Struct StringComposer 

pub struct StringComposer { /* private fields */ }

A composer struct that manages the composition of strings of text consisting of multiple words, including both Hangul words and non-Hangul text.

The StringComposer maintains both a string of completed text and a HangulWordComposer for the current word being composed. If the currently active word is a Hangul word that has not yet been completed, pushing or popping characters will interact with the HangulWordComposer and directly update syllable blocks. Otherwise, Unicode characters will be directly added to or removed from the completed string.

API:

use hangul_cd::string::StringComposer;

let mut composer = StringComposer::new();

// Push characters to form Hangul syllables
composer.push_char('ㅎ').unwrap();
composer.push_char('ㅏ').unwrap();

// Get the composed string
let result = composer.as_string().unwrap();
assert_eq!(result, "하".to_string());

// Push non-Hangul characters
composer.push_char(' ').unwrap();
composer.push_char('!').unwrap();
assert_eq!(composer.as_string().unwrap(), "하 !".to_string());

// Popping non-Hangul characters removes them from the completed string
composer.pop().unwrap(); // removes '!'
composer.pop().unwrap(); // removes ' '
assert_eq!(composer.as_string().unwrap(), "하".to_string());

// Popping Hangul characters after they've been completed removes entire syllables
composer.pop().unwrap(); // removes '하'
assert_eq!(composer.as_string().unwrap(), "".to_string());

// Popping characters while a Hangul word is active removes jamo
composer.push_char('ㅂ').unwrap();
composer.push_char('ㅏ').unwrap();
composer.push_char('ㅂ').unwrap();
composer.pop().unwrap(); // removes 'ㅂ'
assert_eq!(composer.as_string().unwrap(), "바".to_string());

Implementations

impl StringComposer

pub fn new() -> Self

Creates a new, empty StringComposer.

pub fn push_char(&mut self, c: char) -> Result<(), StringError>

Pushes a character to the StringComposer.

If the character is part of a Hangul word, it will be composed into syllables. Otherwise, it will be added directly to the completed string.

pub fn as_string(&self) -> Result<String, StringError>

Returns the composed string, combining completed text and the current word.

pub fn pop(&mut self) -> Result<Option<char>, StringError>

Pops the last character from the StringComposer and returns it wrapped within a Result and Option.

If the current word is a Hangul word with uncompleted syllables, it will remove the last jamo from the current syllable block. Otherwise, it will remove the last character from the completed string.

Trait Implementations

impl Debug for StringComposer

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

Formats the value using the given formatter.

impl Default for StringComposer

fn default() -> Self

Returns the “default value” for a type.