Enum CommentKind 

pub enum CommentKind {
    Line,
    Block,
    DocLine,
    DocBlock,
    Directive,
    License,
    HtmlComment,
    Shebang,
    Encoding,
    OptimizerHint,
    VersionComment,
}

What a comment is, which is what a Policy decides against.

The kind is lexical to begin with and then refined by the comment’s own bytes and position: a // token is Self::Line until it turns out to carry an SPDX identifier (Self::License) or a build tag (Self::Directive).

Variants

Line

An ordinary one-line comment: // ..., # ..., -- ....

Block

An ordinary delimited comment: /* ... */, (* ... *).

DocLine

A one-line documentation comment, such as Rust’s /// and //!.

DocBlock

A delimited documentation comment, such as /** ... */.

Directive

A comment addressed to a tool or to the compiler: a build tag, a linter suppression, a type-checker pragma. spec/directives.toml is the catalogue.

License

A license or copyright notice, such as an SPDX identifier. Only Policy::Legal keeps one.

HtmlComment

An HTML <!-- ... --> comment, which the DOM exposes to scripts.

Shebang

A #! interpreter line at the very start of the file.

Encoding

A Python source-encoding declaration in the first two lines.

OptimizerHint

A SQL optimizer hint, /*+ ... */, which the planner reads.

VersionComment

A SQL version-gated comment, /*! ... */, whose body the server executes.

Implementations

impl CommentKind

pub const ALL: [Self; 11]

Every CLI-visible comment kind.

pub const fn as_str(self) -> &'static str

The canonical name, identical to the serde representation.

pub const fn aliases(self) -> &'static [&'static str]

Accepted spellings besides Self::as_str, already case- and separator-folded.

Trait Implementations

impl Clone for CommentKind

fn clone(&self) -> CommentKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CommentKind

impl Debug for CommentKind

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

Formats the value using the given formatter.

impl Default for CommentKind

fn default() -> CommentKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CommentKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CommentKind

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

Formats the value using the given formatter.

impl Eq for CommentKind

impl FromStr for CommentKind

type Err = String

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for CommentKind

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 CommentKind

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CommentKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CommentKind