ArabicReshaper

Struct ArabicReshaper 

Source
pub struct ArabicReshaper { /* private fields */ }
Expand description

§ArabicReshaper

the main type for reconstructing sentences to be used in applications that don’t support Arabic script.

Implementations§

Source§

impl ArabicReshaper

Source

pub const fn new(config: ReshaperConfig) -> Self

Create a new ArabicReshaper using the given config

Source

pub fn need_reshape<S>(&self, text: S) -> bool
where S: AsRef<str>,

Check whatever the text need reshaping or not.

Source

pub fn reshape<S>(&self, text: S) -> String
where S: AsRef<str>,

Reshape the given line and return the reshaped string

Examples found in repository?
examples/custom_config.rs (line 6)
3fn main() {
4    let reshaper = ReshaperConfig::new(Language::ArabicV2, LigaturesFlags::none()).to_reshaper();
5
6    println!("{}", reshaper.reshape("سهل"));
7}
More examples
Hide additional examples
examples/reshape_line.rs (line 11)
3fn main() {
4    let mut reshaper = ArabicReshaper::default();
5
6    // we can modify config after creating `ArabicReshaper`
7    reshaper.modify_config(|c| {
8        c.delete_harakat = true;
9    });
10
11    println!("{}", reshaper.reshape("ههه"));
12}
Source

pub fn reshape_lines<S, L>(&self, lines: L) -> Vec<String>
where S: AsRef<str>, L: AsRef<[S]>,

Reshape all lines in the given slice and return a new Vec of strings

Examples found in repository?
examples/reshape_lines.rs (line 8)
3fn main() {
4    let reshaper = ArabicReshaper::default();
5
6    let lines = ["به نام خدا", "همه چی درست میشه!"];
7
8    for line in reshaper.reshape_lines(lines) {
9        println!("{line}");
10    }
11}
Source

pub fn modify_config<F>(&mut self, func: F)
where F: FnOnce(&mut ReshaperConfig),

A safe way to modify the config (ReshaperConfig) after creating the ArabicReshaper.

Examples found in repository?
examples/reshape_line.rs (lines 7-9)
3fn main() {
4    let mut reshaper = ArabicReshaper::default();
5
6    // we can modify config after creating `ArabicReshaper`
7    reshaper.modify_config(|c| {
8        c.delete_harakat = true;
9    });
10
11    println!("{}", reshaper.reshape("ههه"));
12}

Trait Implementations§

Source§

impl Clone for ArabicReshaper

Source§

fn clone(&self) -> ArabicReshaper

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for ArabicReshaper

Source§

fn default() -> ArabicReshaper

Returns the “default value” for a type. Read more
Source§

impl From<ReshaperConfig> for ArabicReshaper

Source§

fn from(value: ReshaperConfig) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.