Struct Rule 

pub struct Rule {
    pub key: char,
    pub effect: u8,
    pub effect_type: EffectType,
    pub effect_on: char,
    pub result: char,
    pub appended: [char; 2],
    pub appended_len: u8,
}

A transformation rule that defines how a key press affects the composition.

Fields

key: char

The key that triggers this rule.

effect: u8

Effect value:

• if effect_type == ToneTransformation: this is a Tone as u8
• if effect_type == MarkTransformation: this is a Mark as u8

effect_type: EffectType

The type of transformation to apply.

effect_on: char

The character that this rule targets (to be replaced or marked).

result: char

The resulting character after applying the transformation.

appended: [char; 2]

Additional characters to append immediately after this one (used for multi-character shortcuts).

appended_len: u8

Number of characters in appended.

Implementations

impl Rule

pub fn set_tone(&mut self, tone: Tone)

Sets the effect value from a Tone.

pub fn set_mark(&mut self, mark: Mark)

Sets the effect value from a Mark.

pub fn get_tone(&self) -> Tone

Retrieves the effect value as a Tone.

pub fn get_mark(&self) -> Mark

Retrieves the effect value as a Mark.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl Default for Rule

fn default() -> Rule

Returns the “default value” for a type.

impl Hash for Rule

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 PartialEq for Rule

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Rule

impl Eq for Rule

impl StructuralPartialEq for Rule