Enum caribon::Word

pub enum Word {
    Untracked(String),
    Ignored(String),
    Tracked(String, String, f32, Option<&'static str>),
}

Word type: some inner representation used by Parser.

You probably should not use this type directly.

Variants

Untracked(String)

A String which is not part of the text (typically whitespace, HTML formatting, ...)

Ignored(String)

A word that is ignored, either because it is in parser.ignored or because it is a proper noun and ignore_proper has been set to true.

Tracked(String, String, f32, Option<&'static str>)

Tracked string, containing the string, the stemmed variant of the string, some value corresponding to the degree of repetitions and an option to a highlighting colour

Methods

impl Word

fn set_stemmed(&mut self, s: String)

Sets the stemmed value of a word.

fn set_count(&mut self, x: f32)

Sets the repetition value of a word.

Trait Implementations

impl Clone for Word

fn clone(&self) -> Word

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Word

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

Formats the value using the given formatter.