Struct Stmt 

pub struct Stmt<'arena, 'src> {
    pub kind: StmtKind<'arena, 'src>,
    pub span: Span,
    pub doc_comment: Option<&'arena Comment<'src>>,
}

Fields

kind: StmtKind<'arena, 'src>

span: Span

doc_comment: Option<&'arena Comment<'src>>

The immediately preceding /** */ doc-block, if any.

Only /** */ (doc-block) comments are attached here; //, #, and /* */ comments remain in [ParseResult::comments]. When present, this comment is removed from ParseResult::comments — the two collections are disjoint. A doc-block that has no following statement before the enclosing } or EOF is not attached and stays in ParseResult::comments.

For declaration statements (function, class, interface, …) the doc-block is attached to the inner declaration node (e.g. FunctionDecl::doc_comment) and this field will always be None.

Stored as a pointer into the arena rather than inline so that the None case (the vast majority of statements) costs only 8 bytes instead of the 32 bytes an inline Option<Comment> would require.

Implementations

impl<'arena, 'src> Stmt<'arena, 'src>

pub fn leading_doc_comment(&self) -> Option<&Comment<'src>>

The leading /** */ doc-block for this statement, regardless of where it is stored.

For non-declaration statements (foreach, if, assignments, …) the comment lives on Stmt::doc_comment and is returned directly.

For declaration statements the comment is stored on the inner declaration node — this method checks each variant so callers do not need to match on StmtKind:

StmtKind variant	source field
Function	FunctionDecl::doc_comment
Class	ClassDecl::doc_comment
Interface	InterfaceDecl::doc_comment
Trait	TraitDecl::doc_comment
Enum	EnumDecl::doc_comment
Const	first ConstItem::doc_comment

Returns None when no doc-block precedes the statement.

Trait Implementations

impl<'arena, 'src> Debug for Stmt<'arena, 'src>

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

Formats the value using the given formatter.

impl<'arena, 'src> Serialize for Stmt<'arena, 'src>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.