Struct english_lint::Hint

pub struct Hint {
    pub group: Option<&'static str>,
    pub value: String,
    pub line: Option<usize>,
    pub start: usize,
    pub end: usize,
}

Suggestion on which words to change

Fields

group: Option<&'static str>

Lint group that caught this word

value: String

The actual word

line: Option<usize>

Line this word appeared on (only set when supplied by calling function, should always be present when using the main lint function.)

start: usize

Index the word starts at

end: usize

Index the word ends at

Trait Implementations

impl Debug for Hint

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl PartialEq for Hint

fn eq(&self, __arg_0: &Hint) -> bool

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

fn ne(&self, __arg_0: &Hint) -> bool

This method tests for !=.

impl Eq for Hint

impl Clone for Hint

fn clone(&self) -> Hint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Hint

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

Formats the value using the given formatter.