Enum CommentContent

#[repr(u8)]
pub enum CommentContent {
    None = 0,
    Legal = 1,
    Jsdoc = 2,
    JsdocLegal = 3,
    Pure = 4,
    NoSideEffects = 5,
    Webpack = 6,
    Vite = 7,
    CoverageIgnore = 8,
}

Annotation comment that has special meaning.

Variants

None = 0

No Annotation

Legal = 1

Legal Comment e.g. /* @license */, /* @preserve */, or starts with //! or /*!. https://esbuild.github.io/api/#legal-comments

Jsdoc = 2

/** jsdoc */ https://jsdoc.app

JsdocLegal = 3

A jsdoc containing legal annotation. /** @preserve */

Pure = 4

/* #__PURE__ */ https://github.com/javascript-compiler-hints/compiler-notations-spec

NoSideEffects = 5

/* #__NO_SIDE_EFFECTS__ */

Webpack = 6

Webpack magic comment e.g. /* webpackChunkName */ https://webpack.js.org/api/module-methods/#magic-comments

Vite = 7

Vite comment e.g. /* @vite-ignore */ https://github.com/search?q=repo%3Avitejs%2Fvite%20vite-ignore&type=code

CoverageIgnore = 8

Code Coverage Ignore v8 ignore, c8 ignore, node:coverage, istanbul ignore https://github.com/oxc-project/oxc/issues/10091

Trait Implementations

impl Clone for CommentContent

fn clone(&self) -> CommentContent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'new_alloc> CloneIn<'new_alloc> for CommentContent

type Cloned = CommentContent

The type of the cloned object.

fn clone_in(&self, allocator: &'new_alloc Allocator) -> Self::Cloned

Clone self into the given allocator. allocator may be the same one that self is already in.

fn clone_in_with_semantic_ids( &self, allocator: &'new_alloc Allocator, ) -> Self::Cloned

Almost identical as clone_in, but for some special type, it will also clone the semantic ids. Please use this method only if you make sure semantic info is synced with the ast node.

impl ContentEq for CommentContent

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

This method tests for contents of self and other to be equal.

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

This method tests for contents of self and other not to be equal. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Debug for CommentContent

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

Formats the value using the given formatter.

impl Default for CommentContent

fn default() -> CommentContent

Returns the “default value” for a type.

impl PartialEq for CommentContent

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

impl Eq for CommentContent

impl StructuralPartialEq for CommentContent