Struct nlprule::rules::Rules

pub struct Rules { /* fields omitted */ }

A set of grammatical error correction rules.

Implementations

impl Rules

pub fn new<P: AsRef<Path>>(p: P) -> Result<Self, Error>

Creates a new rules set from a path to a binary.

Errors

• If the file can not be opened.
• If the file content can not be deserialized to a rules set.

pub fn from_reader<R: Read>(reader: R) -> Result<Self, Error>

Creates a new rules set from a reader.

pub fn rules(&self) -> &[Rule]

All rules ordered by priority.

pub fn rule(&self, id: &str) -> Option<&Rule>

Finds a rule by ID.

pub fn apply(
    &self,
    tokens: &[Token<'_>],
    tokenizer: &Tokenizer
) -> Vec<Suggestion>

Compute the suggestions for the given tokens by checking all rules.

pub fn suggest(&self, text: &str, tokenizer: &Tokenizer) -> Vec<Suggestion>

Compute the suggestions for a text by checking all rules.

pub fn correct(&self, text: &str, tokenizer: &Tokenizer) -> String

Correct a text by first tokenizing, then finding all suggestions and choosing the first replacement of each suggestion.

pub fn iter(&self) -> RulesIter<'_>

A referential iterator.

Trait Implementations

impl Default for Rules

fn default() -> Rules

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Rules

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

Deserialize this value from the given Serde deserializer.

impl<R> FromIterator<R> for Rules where
    R: Into<Rule>, 

fn from_iter<I: IntoIterator<Item = R>>(iter: I) -> Self

Creates a value from an iterator.

impl IntoIterator for Rules

type Item = Rule

The type of the elements being iterated over.

type IntoIter = RulesIntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for Rules

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

Serialize this value into the given Serde serializer.