Hebrew_Unicode_Utils

Table of contents

• Hebrew_Unicode_Utils
  • Table of contents
  • Description
    • Notes
  • Examples
    • Removing characters
    • Showing characters
    • Statistics
  • Install
  • Safety
  • Panics
  • Errors
  • License
  • Contribution

Description

This crate (hebrew_unicode_utils) is a library written in Rust and can be used for editing strings which contains Hebrew characters. It is built on top of the low-level crate hebrew_unicode_script.

Functionality of this crate will only focus on the Unicode Block Hebrew.

The types of functionality of this library can be captured in the following three categories:

1. Removing characters

   This is about removing a certain set of Hebrew character types from a string.

2. Showing characters

   This category is all about showing a particular type of Hebrew characters, for example, only vowel characters.

   The idea behind this is that this could help people (who want to learn Hebrew) to distinguish the different characters.

   Note:
   Consonants will always be shown in combination with e.g. vowel characters, otherwise the readability will decrease. For example, if there are multiple vowels in one sentence, then if there are no consonants shown, then all vowels will be displayed on top of each other. Which would make the sentence unreadable.

3. Statistics

   This category contains functionality that gives the user information about the particular statistics of a text string.

   For example an answer on the following question: "What Hebrew character types are in my text string?"

For an overview of released versions see releases.

Notes

• Vowels are sometimes called Hebrew Points
• Accents are sometimes called Hebrew Cantilationmarks

^ TOC

Examples

Removing characters

use hebrew_unicode_utils::remove_hbr_ligature_yiddish;
    
let test_str = "XװױײZ";
let test_str_filtered = remove_hbr_ligature_yiddish(test_str);

assert_eq!(test_str_filtered.as_ref(),"XZ");

use hebrew_unicode_utils::remove_hbr_accent;

let test_str = "בְּרֵאשִׁ֖ית";
let test_str_filtered = remove_hbr_accent(test_str);

assert_eq!(test_str_filtered.as_ref(), "בְּרֵאשִׁית");

Showing characters

use hebrew_unicode_utils::show_hbr_mark;

let input_str = "Q מִצְרָ֑יְמָה ה֯";
let input_str_showed = show_hbr_mark(input_str);
        
assert_eq!(input_str_showed.as_ref(), "Q מצרימה ה֯");

use hebrew_unicode_utils::show_hbr_point_semi_vowel;

let input_str = "ֲדְ נָפֶשׁ גֱכֳע";
let input_str_showed = show_hbr_point_semi_vowel(input_str);

assert_eq!(input_str_showed.as_ref(), "ֲדְ נפש גֱכֳע");
    

Statistics

use hebrew_unicode_utils::get_hbr_character_frequency;
    
let input_string = "Xבהב";
let freq_map = get_hbr_character_frequency(input_string);
assert_eq!(freq_map.contains_key("X"), false);
assert_eq!(freq_map.get(&"ב".to_string()), Some(&2));  
assert_eq!(freq_map.get(&"ה".to_string()), Some(&1));

use hebrew_unicode_utils::get_hbr_character_types;
    
let input_string = "Xבהב";
let type_struct = get_hbr_character_types(input_string);
assert_eq!(type_struct.accent, false);
assert_eq!(type_struct.consonant, true);
assert_eq!(type_struct.non_hebrew, true);

Install

For installation see the hebrew_unicode_utils page at crates.io.

Safety

All functions are written in safe Rust.

^ TOC

Panics

No panics for so far I know of.

^ TOC

Errors

All functions return either a Cow, a Struct or a HashMap.

^ TOC

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

^ TOC

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

^ TOC

This crate has been inspired by niqqud