Struct abjad::AbjadPrefs

pub struct AbjadPrefs {
    pub count_shaddah: bool,
    pub double_alif_maddah: bool,
    pub ignore_lone_hamzah: bool,
    pub letter_order: LetterOrder,
}

We need to allow some options for abjad calculation. At present there are four: three booleans and one enum. All of the booleans are false by default. The enum also has a default value, which should be suitable for the vast majority of use cases. If you don’t need to change any of the options, then, when calling one of the methods, you can simply pass AbjadPrefs::default().

Fields

count_shaddah: bool

Count the shaddah diacritic? This will have the effect of doubling the value of the preceding letter.

double_alif_maddah: bool

Count alif maddah as a double alif (with value 2 instead of 1)?

ignore_lone_hamzah: bool

Ignore the pseudo-letter hamzah in its isolated state? (By default we assign it a value of 1.)

letter_order: LetterOrder

Which letter order to use: Mashriqi (default) or Maghribi? (Unless you are certain that you need the latter, you probably don’t.)

Trait Implementations

impl Clone for AbjadPrefs

fn clone(&self) -> AbjadPrefs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AbjadPrefs

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

Formats the value using the given formatter.

impl Default for AbjadPrefs

fn default() -> AbjadPrefs

Returns the “default value” for a type.

impl Hash for AbjadPrefs

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for AbjadPrefs

fn cmp(&self, other: &AbjadPrefs) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<AbjadPrefs> for AbjadPrefs

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<AbjadPrefs> for AbjadPrefs

fn partial_cmp(&self, other: &AbjadPrefs) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for AbjadPrefs

impl Eq for AbjadPrefs

impl StructuralEq for AbjadPrefs

impl StructuralPartialEq for AbjadPrefs