Struct CommentTokens 

pub struct CommentTokens {
    pub line: Option<String>,
    pub block_start: Option<String>,
    pub block_end: Option<String>,
}

Comment syntax for a language.

Describes how to create line and block comments.

Example

use reovim_driver_syntax::CommentTokens;

// C-style comments
let c_style = CommentTokens::with_block("//", "/*", "*/");
assert!(c_style.has_line_comment());
assert!(c_style.has_block_comment());

// Python-style (line only)
let python = CommentTokens::line_only("#");
assert!(python.has_line_comment());
assert!(!python.has_block_comment());

// HTML-style (block only)
let html = CommentTokens::block_only("<!--", "-->");
assert!(!html.has_line_comment());
assert!(html.has_block_comment());

Fields

line: Option<String>

Line comment prefix (e.g., “//”, “#”, “–”).

block_start: Option<String>

Block comment start (e.g., “/*”, “<!–”).

block_end: Option<String>

Block comment end (e.g., “*/”, “–>”).

Implementations

impl CommentTokens

pub fn line_only(prefix: impl Into<String>) -> Self

Create comment tokens with only a line comment.

pub fn with_block( line: impl Into<String>, block_start: impl Into<String>, block_end: impl Into<String>, ) -> Self

Create comment tokens with both line and block comments.

pub fn block_only(start: impl Into<String>, end: impl Into<String>) -> Self

Create comment tokens with only block comments (no line comments).

pub const fn has_line_comment(&self) -> bool

Check if line comments are supported.

pub const fn has_block_comment(&self) -> bool

Check if block comments are supported.

pub const fn has_any(&self) -> bool

Check if any comment syntax is defined.

Trait Implementations

impl Clone for CommentTokens

fn clone(&self) -> CommentTokens

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommentTokens

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

Formats the value using the given formatter.

impl Default for CommentTokens

fn default() -> CommentTokens

Returns the “default value” for a type.

impl PartialEq for CommentTokens

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

impl StructuralPartialEq for CommentTokens