Enum doc_chunks::literal::CommentVariant

#[non_exhaustive]
pub enum CommentVariant {
    TripleSlash,
    DoubleSlashEM,
    SlashAsteriskEM,
    SlashAsteriskAsterisk,
    SlashAsterisk,
    MacroDocEqStr(String, usize),
    MacroDocEqMacro,
    CommonMark,
    DoubleSlash,
    SlashStar,
    Unknown,
    TomlEntry,
}

Track what kind of comment the literal is

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

TripleSlash

///

DoubleSlashEM

//!

SlashAsteriskEM

/*!

SlashAsteriskAsterisk

/**

SlashAsterisk

/*

MacroDocEqStr(String, usize)

#[doc= with actual prefix like #[doc= and the total length of r### etc. including r but without "

MacroDocEqMacro

#[doc= foo!(..)], content will be ignored, but allows clusters to not continue.

CommonMark

Commonmark File

DoubleSlash

Developer line comment

SlashStar

Developer block comment

Unknown

Unknown Variant

TomlEntry

Toml entry

Implementations

impl CommentVariant

pub fn category(&self) -> CommentVariantCategory

Obtain the comment variant category.

pub fn prefix_string(&self) -> String

Return the prefix string.

Does not include whitespaces for /// and //! variants!

pub fn prefix_len(&self) -> usize

Return length (in bytes) of comment prefix for each variant.

By definition matches the length of prefix_string.

pub fn suffix_len(&self) -> usize

Return suffix of different comment variants

pub fn suffix_string(&self) -> String

Return string which will be appended to each line

Trait Implementations

impl Clone for CommentVariant

fn clone(&self) -> CommentVariant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommentVariant

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

Formats the value using the given formatter.

impl Default for CommentVariant

fn default() -> Self

Returns the “default value” for a type.

impl Hash for CommentVariant

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 CommentVariant

fn eq(&self, other: &CommentVariant) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CommentVariant

impl StructuralEq for CommentVariant

impl StructuralPartialEq for CommentVariant