hebrew_unicode_utils 0.1.1

Some functions for processing Hebrew unicode characters.
Documentation
hebrew_unicode_utils-0.1.1 has been yanked.

Hebrew_Unicode_Utils

Table of contents

Introduction

This current readme gives a rough overview of the functionality as I currently envision it and functions as a model for implentation!

I know the target audience for this crate is small, but perhaps there are others who are interested and have ideas and/or wishes they would like to see applied to this crate.
Please let me know, so that we can discuss whether your ideas are suitable and feasible for this crate.

Note: This section will be updated or deleted over time.

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 four categories:

  1. Removing

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

  2. Showing

    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. Current practices

    On the Internet, certain ways have already been established for displaying Hebrew text. The idea is to include functionality that is already used by various websites.

    One example is the BlueLetterBible, where it is possible to show cantilation marks and or vowel points on top of the consonants.

    The implementation usually consists of the following components:

    • Consonants: Show only consonants with the Maqqef's and Sof Pasuq's.
    • Vowels: Show consonants + all vowels.
    • Accents: Show Vowels + all accents.

  4. Statistics

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

    For example, what Hebrew character types are in my text string?

Notes

  • Vowels are sometimes called Hebrew Points
  • Accents are sometimes called Hebrew Cantilationmarks
  • Sof Pasuq (סוֹף פָּסוּק) U+05C3 => ׃׃
  • Maqaf (מַקָּף) U+05be => ־

For an overview of released versions see releases.

^ TOC

## Safety

All functions are written in safe Rust.

^ TOC

## Panics

Not that I am aware of.

^ TOC

## Errors

All (trait)functions return either true or false.

^ 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