Enum TokenKind

pub enum TokenKind {
    Word(WordMetadata),
    Punctuation(Punctuation),
    Number(OrderedFloat<f64>, Option<NumberSuffix>),
    Space(usize),
    Newline(usize),
    EmailAddress,
    Url,
    Hostname,
    Unlintable,
    ParagraphBreak,
}

Variants

Word(WordMetadata)

Punctuation(Punctuation)

Number(OrderedFloat<f64>, Option<NumberSuffix>)

Space(usize)

A sequence of “ “ spaces.

Newline(usize)

A sequence of “\n” newlines

EmailAddress

Url

Hostname

Unlintable

A special token used for things like inline code blocks that should be ignored by all linters.

ParagraphBreak

Implementations

impl TokenKind

pub const fn is_word(&self) -> bool

Returns true if self is of variant Word.

pub fn as_word(&self) -> Option<&WordMetadata>

Returns Some if self is a reference of variant Word, and None otherwise.

pub fn as_mut_word(&mut self) -> Option<&mut WordMetadata>

Returns Some if self is a mutable reference of variant Word, and None otherwise.

pub fn expect_word(self) -> WordMetadata

where Self: Debug,

Unwraps the value, yielding the content of Word.

Panics

Panics if the value is not Word, with a panic message including the content of self.

pub fn word(self) -> Option<WordMetadata>

Returns Some if self is of variant Word, and None otherwise.

pub const fn is_punctuation(&self) -> bool

Returns true if self is of variant Punctuation.

pub fn as_punctuation(&self) -> Option<&Punctuation>

Returns Some if self is a reference of variant Punctuation, and None otherwise.

pub fn as_mut_punctuation(&mut self) -> Option<&mut Punctuation>

Returns Some if self is a mutable reference of variant Punctuation, and None otherwise.

pub fn expect_punctuation(self) -> Punctuation

where Self: Debug,

Unwraps the value, yielding the content of Punctuation.

Panics

Panics if the value is not Punctuation, with a panic message including the content of self.

pub fn punctuation(self) -> Option<Punctuation>

Returns Some if self is of variant Punctuation, and None otherwise.

pub const fn is_number(&self) -> bool

Returns true if self is of variant Number.

pub fn as_number(&self) -> Option<(&OrderedFloat<f64>, &Option<NumberSuffix>)>

Returns Some if self is a reference of variant Number, and None otherwise.

pub fn as_mut_number( &mut self, ) -> Option<(&mut OrderedFloat<f64>, &mut Option<NumberSuffix>)>

Returns Some if self is a mutable reference of variant Number, and None otherwise.

pub fn expect_number(self) -> (OrderedFloat<f64>, Option<NumberSuffix>)

where Self: Debug,

Unwraps the value, yielding the content of Number.

Panics

Panics if the value is not Number, with a panic message including the content of self.

pub fn number(self) -> Option<(OrderedFloat<f64>, Option<NumberSuffix>)>

Returns Some if self is of variant Number, and None otherwise.

pub const fn is_space(&self) -> bool

Returns true if self is of variant Space.

pub fn as_space(&self) -> Option<&usize>

Returns Some if self is a reference of variant Space, and None otherwise.

pub fn as_mut_space(&mut self) -> Option<&mut usize>

Returns Some if self is a mutable reference of variant Space, and None otherwise.

pub fn expect_space(self) -> usize

where Self: Debug,

Unwraps the value, yielding the content of Space.

Panics

Panics if the value is not Space, with a panic message including the content of self.

pub fn space(self) -> Option<usize>

Returns Some if self is of variant Space, and None otherwise.

pub const fn is_newline(&self) -> bool

Returns true if self is of variant Newline.

pub fn as_newline(&self) -> Option<&usize>

Returns Some if self is a reference of variant Newline, and None otherwise.

pub fn as_mut_newline(&mut self) -> Option<&mut usize>

Returns Some if self is a mutable reference of variant Newline, and None otherwise.

pub fn expect_newline(self) -> usize

where Self: Debug,

Unwraps the value, yielding the content of Newline.

Panics

Panics if the value is not Newline, with a panic message including the content of self.

pub fn newline(self) -> Option<usize>

Returns Some if self is of variant Newline, and None otherwise.

pub const fn is_email_address(&self) -> bool

Returns true if self is of variant EmailAddress.

pub const fn is_url(&self) -> bool

Returns true if self is of variant Url.

pub const fn is_hostname(&self) -> bool

Returns true if self is of variant Hostname.

pub const fn is_unlintable(&self) -> bool

Returns true if self is of variant Unlintable.

pub const fn is_paragraph_break(&self) -> bool

Returns true if self is of variant ParagraphBreak.

impl TokenKind

pub fn is_open_square(&self) -> bool

pub fn is_close_square(&self) -> bool

pub fn is_pipe(&self) -> bool

pub fn is_pronoun(&self) -> bool

pub fn is_conjunction(&self) -> bool

pub fn is_ellipsis(&self) -> bool

pub fn is_swear(&self) -> bool

pub fn matches_variant_of(&self, other: &Self) -> bool

Checks that self is the same enum variant as other, regardless of whether the inner metadata is also equal.

pub fn with_default_data(&self) -> Self

Produces a copy of self with any inner data replaced with it’s default value. Useful for making comparisons on just the variant of the enum.

impl TokenKind

pub fn blank_word() -> Self

Construct a TokenKind::Word with no (default) metadata.

impl TokenKind

pub fn as_mut_quote(&mut self) -> Option<&mut Quote>

pub fn as_quote(&self) -> Option<&Quote>

pub fn is_quote(&self) -> bool

pub fn is_apostrophe(&self) -> bool

pub fn is_period(&self) -> bool

pub fn is_at(&self) -> bool

pub fn is_case_separator(&self) -> bool

Used by crate::parsers::CollapseIdentifiers TODO: Separate this into two functions and add OR functionality to pattern matching

pub fn is_verb(&self) -> bool

pub fn is_linking_verb(&self) -> bool

pub fn is_noun(&self) -> bool

pub fn is_comma(&self) -> bool

pub fn is_whitespace(&self) -> bool

Checks whether the token is whitespace.

Trait Implementations

impl Clone for TokenKind

fn clone(&self) -> TokenKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TokenKind

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

Formats the value using the given formatter.

impl Default for TokenKind

fn default() -> TokenKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for TokenKind

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 TokenKind

fn eq(&self, other: &TokenKind) -> 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 PartialOrd for TokenKind

fn partial_cmp(&self, other: &TokenKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TokenKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TokenKind

impl Eq for TokenKind

impl StructuralPartialEq for TokenKind