Struct solang_parser::doccomment::DocCommentTag

pub struct DocCommentTag {
    pub tag: String,
    pub tag_offset: usize,
    pub value: String,
    pub value_offset: usize,
}

A Solidity doc comment’s tag, value and respective offsets.

Fields

tag: String

The tag of the doc comment, like the notice in /// @notice Doc comment value

tag_offset: usize

The offset of the comment’s tag, relative to the start of the source string.

value: String

The actual comment string, like Doc comment value in /// @notice Doc comment value

value_offset: usize

The offset of the comment’s value, relative to the start of the source string.

Trait Implementations

impl Clone for DocCommentTag

fn clone(&self) -> DocCommentTag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocCommentTag

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

Formats the value using the given formatter.

impl Default for DocCommentTag

fn default() -> DocCommentTag

Returns the “default value” for a type.

impl PartialEq<DocCommentTag> for DocCommentTag

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

impl StructuralEq for DocCommentTag

impl StructuralPartialEq for DocCommentTag