Enum CommentStyle

pub enum CommentStyle {
    Block = 0,
    BlockStar = 1,
    BlockBang = 2,
    BlockPound = 3,
    BlockHeading = 4,
    Single = 5,
    SingleStar = 6,
    SingleBang = 7,
}

An enum representing the “Style” the Kind::Comment token represents.

A Token with Kind::Comment will store this data internal to the token. Using Token::comment_style() will return this enum, depending on what characters make up the beginning of the comment token. By default the Lexer will only produce multi-line - aka “Block” - comments, but adding Feature::SeparateWhitespace will allow the Lexer to produce single line comments too.

A basic Block comment style uses the /* leading characters, but sub-styles of the block style are also computed, for example BlockStar represents a comment using the “double star” syntax to open the comment, i.e. /**. Determing if these comments are using these alternate style can help a parser (or writer) determine if it should retain these comments or otherwise treat them differently to regular block comments.

use css_lexer::*;
let mut lexer = Lexer::new("/* Normal Comment */  /** Double Star Comment */");
{
    // This token will be collapsed Whitespace.
    let token = lexer.advance();
    assert_eq!(token, Kind::Comment);
    assert_eq!(token, CommentStyle::Block);
}
assert_eq!(lexer.advance(), Kind::Whitespace);
{
    // This token will be collapsed Whitespace.
    let token = lexer.advance();
    assert_eq!(token, Kind::Comment);
    assert_eq!(token, CommentStyle::BlockStar);
}

Variants

Block = 0

A basic block comment which uses /* as the leading style. The third character may be a whitespace, or may include a character that isn’t !, #, =, -.

BlockStar = 1

A block comment which uses /** as the leading style. The two *s must be adjacent, so this does not count /* *.

BlockBang = 2

A block comment which uses /*! as the leading style. The * and ! must be adjacent, so this does not count /* !.

BlockPound = 3

A block comment which uses /*# as the leading style. The * and # must be adjacent, so this does not count /* #.

BlockHeading = 4

A block comment which uses /*= or /*- as the leading style. The * and - or = must be adjacent, so this does not count /* #.

Single = 5

A basic single line comment which uses // as the leading style. The third character may be a whitespace, or may include a character that isn’t *, !. The Lexer can only produce a Token with this style if Feature::SingleLineComments is enabled.

SingleStar = 6

A single line comment which uses //* as the leading style. The * be adjacent to the //, so this does not count // *. The Lexer can only produce a Token with this style if Feature::SingleLineComments is enabled.

SingleBang = 7

A single line comment which uses //! as the leading style. The ! be adjacent to the //, so this does not count // !. The Lexer can only produce a Token with this style if Feature::SingleLineComments is enabled.

Implementations

impl CommentStyle

pub fn is_block(&self) -> bool

pub fn is_non_standard(&self) -> bool

pub fn retain(&self) -> bool

Trait Implementations

impl Clone for CommentStyle

fn clone(&self) -> CommentStyle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommentStyle

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

Formats the value using the given formatter.

impl Default for CommentStyle

fn default() -> CommentStyle

Returns the “default value” for a type.

impl Hash for CommentStyle

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 Ord for CommentStyle

fn cmp(&self, other: &CommentStyle) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<CommentStyle> for &Cursor

fn eq(&self, other: &CommentStyle) -> 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 PartialEq<CommentStyle> for Cursor

fn eq(&self, other: &CommentStyle) -> 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 PartialEq<CommentStyle> for SourceCursor<'_>

fn eq(&self, other: &CommentStyle) -> 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 PartialEq<CommentStyle> for Token

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

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

fn partial_cmp(&self, other: &CommentStyle) -> 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 CommentStyle

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 CommentStyle

impl Eq for CommentStyle

impl StructuralPartialEq for CommentStyle