Struct nlprule::rule::Rule

pub struct Rule { /* fields omitted */ }

A grammar rule. Returns a Suggestion for change if it matches. Sourced from LanguageTool. An example of how a simple rule might look in the original XML format:

<rule id="DOSNT" name="he dosn't (doesn't)">
    <pattern>
        <token regexp="yes">do[se]n|does|dosan|doasn|dosen</token>
        <token regexp="yes">['’`´‘]</token>
        <token>t</token>
    </pattern>
    <message>Did you mean <suggestion>doesn\2t</suggestion>?</message>
    <example correction="doesn't">He <marker>dosn't</marker> know about it.</example>
</rule>

Implementations

impl Rule

pub fn enable(&mut self)

Hints that this rule should be enabled.

pub fn disable(&mut self)

Hints that this rule should be disabled.

pub fn enabled(&self) -> bool

Hints whether the rule should be enabled in a rule set.

pub fn id(&self) -> &Index

Get a unique identifier of this rule.

pub fn short(&self) -> Option<&str>

Gets a short text describing this rule e.g. “Possible typo” if there is one.

pub fn url(&self) -> Option<&str>

Gets an url with more information about this rule if there is one.

pub fn examples(&self) -> &[Example]

Gets the examples associated with this rule.

pub fn name(&self) -> &str

Gets a human-readable name of this rule.

pub fn category_name(&self) -> &str

Gets a human-readable name of the category this rule is in.

pub fn category_type(&self) -> Option<&str>

Gets the type of the category this rule is in e. g. “style” or “grammar”.

pub fn test(&self, tokenizer: &Tokenizer) -> bool

Grammar rules always have at least one example associated with them. This method checks whether the correct action is taken in the examples.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a copy of the value.

pub 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<'de> Deserialize<'de> for Rule

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Rule

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

Formats the value using the given formatter.

impl Serialize for Rule

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.