Enum sway_ast::token::CommentKind

pub enum CommentKind {
    Newlined,
    Trailing,
    Inlined,
    Multilined,
}

Variants

Newlined

A newlined comment is a comment with a preceding newline before another token.

Examples

pub fn main() -> bool {

    // Newlined comment
    true
}

Trailing

A trailing comment is a comment without a preceding newline before another token.

Examples

var foo = 1; // Trailing comment

Inlined

An inlined comment is a block comment nested between 2 tokens without a newline after it.

Examples

fn some_function(baz: /* inlined comment */ u64) {}

Multilined

A multiline comment is a block comment that may be nested between 2 tokens with 1 or more newlines within it.

Examples

fn some_function(baz: /* multiline
                         comment */ u64) {}

Trait Implementations

impl Clone for CommentKind

fn clone(&self) -> CommentKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommentKind

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

Formats the value using the given formatter.

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<CommentKind> for CommentKind

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

fn partial_cmp(&self, other: &CommentKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for CommentKind

impl StructuralEq for CommentKind

impl StructuralPartialEq for CommentKind