Enum solang_parser::pt::Comment

pub enum Comment {
    Line(Loc, String),
    Block(Loc, String),
    DocLine(Loc, String),
    DocBlock(Loc, String),
}

A comment or doc comment.

Variants

Line(Loc, String)

A line comment.

// line comment

Block(Loc, String)

A block doc comment.

/* block comment */

DocLine(Loc, String)

A line doc comment.

/// line doc comment

DocBlock(Loc, String)

A block doc comment.

/**
 * block doc comment
 */

Implementations

impl Comment

pub const fn value(&self) -> &String

Returns the comment’s value.

pub const fn is_doc(&self) -> bool

Returns whether this is a doc comment.

pub const fn is_line(&self) -> bool

Returns whether this is a line comment.

pub const fn is_block(&self) -> bool

Returns whether this is a block comment.

Trait Implementations

impl Clone for Comment

fn clone(&self) -> Comment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CodeLocation for Comment

fn loc(&self) -> Loc

Returns the code location of self.

impl Debug for Comment

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

Formats the value using the given formatter.

impl Display for Comment

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

Formats the value using the given formatter.

impl OptionalCodeLocation for Comment

fn loc_opt(&self) -> Option<Loc>

Returns the optional code location of self.

impl PartialEq for Comment

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

impl StructuralPartialEq for Comment