Struct biome_formatter::comments::DecoratedComment

pub struct DecoratedComment<L: Language> { /* private fields */ }

A comment decorated with additional information about its surrounding context in the source document.

Used by CommentStyle::place_comment to determine if this should become a leading, dangling, or trailing comment.

Implementations

impl<L: Language> DecoratedComment<L>

pub fn enclosing_node(&self) -> &SyntaxNode<L>

The closest parent node that fully encloses the comment.

A node encloses a comment when the comment is between two of its direct children (ignoring lists).

Examples

[a, /* comment */ b]

The enclosing node is the array expression and not the identifier b because a and b are children of the array expression and comment is a comment between the two nodes.

pub fn piece(&self) -> &SyntaxTriviaPieceComments<L>

Returns the comment piece.

pub fn preceding_node(&self) -> Option<&SyntaxNode<L>>

Returns the node preceding the comment.

The direct child node (ignoring lists) of the enclosing_node that precedes this comment.

Returns None if the enclosing_node only consists of tokens or if all preceding children of the enclosing_node have been tokens.

The Preceding node is guaranteed to be a sibling of following_node.

Examples

Preceding tokens only

[/* comment */]

Returns None because the comment has no preceding node, only a preceding [ token.

Preceding node

[a /* comment */, b]

Returns Some(a) because a directly precedes the comment.

Preceding token and node

[a, /* comment */]

Returns Some(a) because a is the preceding node of comment. The presence of the , token doesn’t change that.

pub fn following_node(&self) -> Option<&SyntaxNode<L>>

Returns the node following the comment.

The direct child node (ignoring lists) of the enclosing_node that follows this comment.

Returns None if the enclosing_node only consists of tokens or if all children children of the enclosing_node following this comment are tokens.

The following node is guaranteed to be a sibling of preceding_node.

Examples

Following tokens only

[ /* comment */ ]

Returns None because there’s no node following the comment, only the ] token.

Following node

[ /* comment */ a ]

Returns Some(a) because a is the node directly following the comment.

Following token and node

async /* comment */ function test() {}

Returns Some(test) because the test identifier is the first node following comment.

Following parenthesized expression

!(
    a /* comment */
);
b

Returns None because comment is enclosed inside the parenthesized expression and it has no children following `/* comment */.

pub fn lines_before(&self) -> u32

The number of line breaks between this comment and the previous token or comment.

Examples

Same line

a // end of line

Returns 0 because there’s no line break between the token a and the comment.

Own Line

a;

/* comment */

Returns 2 because there are two line breaks between the token a and the comment.

pub fn lines_after(&self) -> u32

The number of line breaks right after this comment.

Examples

End of line

a; // comment

b;

Returns 2 because there are two line breaks between the comment and the token b.

Same line

a;
/* comment */ b;

Returns 0 because there are no line breaks between the comment and the token b.

pub fn kind(&self) -> CommentKind

Returns the CommentKind of the comment.

pub fn text_position(&self) -> CommentTextPosition

The position of the comment in the text.

pub fn following_token(&self) -> Option<&SyntaxToken<L>>

The next token that comes after this comment. It is possible that other comments are between this comment and the token.

a /* comment */ /* other */ b

The following_token for both comments is b because it’s the token coming after the comments.

Trait Implementations

impl<L: Clone + Language> Clone for DecoratedComment<L>

fn clone(&self) -> DecoratedComment<L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<L: Debug + Language> Debug for DecoratedComment<L>

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

Formats the value using the given formatter.

impl<L: Language> From<DecoratedComment<L>> for SourceComment<L>

fn from(decorated: DecoratedComment<L>) -> Self

Converts to this type from the input type.