Struct ReshaperConfig 

pub struct ReshaperConfig {
    pub language: Language,
    pub delete_harakat: bool,
    pub shift_harakat_position: bool,
    pub delete_tatweel: bool,
    pub support_zwj: bool,
    pub use_unshaped_instead_of_isolated: bool,
    pub support_ligatures: bool,
    pub ligatures: Ligatures,
}

The main Config struct for the ArabicReshaper

You can change all kinds of settings about ArabicReshaper using this struct.

Fields

language: Language

Supported languages are: Arabic, ArabicV2, Kurdish More languages might be supported soon.

delete_harakat: bool

Whether to delete the Harakat (Tashkeel) before reshaping or not.

shift_harakat_position: bool

Whether to shift the Harakat (Tashkeel) one position so they appear correctly when string is reversed

delete_tatweel: bool

Whether to delete the Tatweel (U+0640) before reshaping or not.

support_zwj: bool

Whether to support ZWJ (U+200D) or not.

use_unshaped_instead_of_isolated: bool

Use unshaped form instead of isolated form.

support_ligatures: bool

Whether to use ligatures or not. Serves as a shortcut to disable all ligatures.

ligatures: Ligatures

When support_ligatures is enabled. Separate ligatures configuration take precedence over it. When support_ligatures is disabled, separate ligatures configurations are ignored.

Implementations

impl ReshaperConfig

pub const fn new(language: Language, ligatures_flags: LigaturesFlags) -> Self

Create a new ReshaperConfig with the given LigaturesFlags.

Examples found in repository

examples/custom_config.rs (line 4)

fn main() {
    let reshaper = ReshaperConfig::new(Language::ArabicV2, LigaturesFlags::none()).to_reshaper();

    println!("{}", reshaper.reshape("سهل"));
}

pub fn to_reshaper(self) -> ArabicReshaper

Create a new ArabicReshaper from the config.

Examples found in repository

examples/custom_config.rs (line 4)

fn main() {
    let reshaper = ReshaperConfig::new(Language::ArabicV2, LigaturesFlags::none()).to_reshaper();

    println!("{}", reshaper.reshape("سهل"));
}

pub fn update_ligature(&mut self, name: LigatureNames, enable: bool)

Update the given LigatureNames.

Trait Implementations

impl Clone for ReshaperConfig

fn clone(&self) -> ReshaperConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ReshaperConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<ReshaperConfig> for ArabicReshaper

fn from(value: ReshaperConfig) -> Self

Converts to this type from the input type.