Skip to main content

Options

Struct Options 

Source
pub struct Options {
    pub expand_presentation_forms: bool,
    pub fold_letters: bool,
    pub strip_aerab: bool,
    pub strip_tatweel: bool,
    pub strip_format_marks: bool,
    pub ascii_digits: bool,
    pub collapse_whitespace: bool,
}
Expand description

Which normalization steps to apply.

Every field defaults to true except ascii_digits. Use ..Options::default() to change one thing, or Options::none() to start from all-off.

use urdu_text::Options;

let o = Options { collapse_whitespace: false, ..Options::default() };
assert!(o.fold_letters);
assert!(!o.collapse_whitespace);

Fields§

§expand_presentation_forms: bool

Map Arabic Presentation Forms-B (U+FE80–U+FEFC) back to base letters, expanding the lam-alef ligatures into two characters.

Turn this on for anything extracted from a PDF. Default: true.

§fold_letters: bool

Fold shape-identical Arabic and Persian letterforms to their Urdu codepoints — see fold_letter for the exact table, including the four folds this crate refuses to make.

Default: true.

§strip_aerab: bool

Remove aerab (harakat / diacritics), leaving hamza in place.

See is_aerab_char for why hamza is excluded. Default: true.

§strip_tatweel: bool

Remove tatweel (U+0640), the kashida elongation used to justify lines of text. Default: true.

§strip_format_marks: bool

Remove invisible formatting and bidi control characters: zero-width space/joiner/non-joiner, LRM/RLM, the embedding and isolate controls, and the BOM.

Default: true.

§ascii_digits: bool

Convert Urdu and Arabic-Indic digits to ASCII 0–9.

Defaults to false, unlike every other field. Rewriting ۲۰۲۴ as 2024 changes how the text reads, so it is opt-in: right for a search index, wrong for text you intend to display back to a reader.

§collapse_whitespace: bool

Collapse each run of whitespace to a single ASCII space, and trim the leading and trailing runs.

Runs after format marks are stripped, so a zero-width space wedged between two blanks does not defeat the collapse. Default: true.

Implementations§

Source§

impl Options

Source

pub const fn none() -> Self

Every step switched off — a starting point for building up exactly the normalization you want.

normalize_with(s, &Options::none()) returns s unchanged.

use urdu_text::{normalize_with, Options};

let only_ligatures = Options {
    expand_presentation_forms: true,
    ..Options::none()
};
// The ligature expands to lam + alef, but Arabic kaf is left alone.
assert_eq!(
    normalize_with("\u{FEFB}\u{0643}", &only_ligatures),
    "\u{0644}\u{0627}\u{0643}"
);

Trait Implementations§

Source§

impl Clone for Options

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Options

Source§

impl Debug for Options

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Options

Source§

fn default() -> Self

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

impl Eq for Options

Source§

impl Hash for Options

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Options

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Options

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.