Struct DocComment 

pub struct DocComment { /* private fields */ }

Implementations

impl DocComment

pub fn is_inner(&self) -> bool

true for the inner (//!) form — a run whose tokens are DOC_COMMENT_INNER rather than DOC_COMMENT_OUTER. One node shape covers both variants (syntax_kind.rs’s DOC_COMMENT doc); this is how callers tell them apart. A well-formed DOC_COMMENT node’s comment tokens are always uniformly one kind or the other (the parser’s doc_comment::consume_doc_run never mixes them within a single run), so checking the first one is sufficient.

pub fn lines(&self) -> Vec<(String, TextRange)>

Every doc-comment line in source order: the token’s text with its //////! marker stripped and a single leading space (if any) trimmed, paired with that token’s source range — the same shape the OLD ink parser’s collect_doc_lines produces, so both frontends feed the identical format-agnostic hir::doc_block::parse_lines tag parser.

Trait Implementations

impl AstNode for DocComment

fn can_cast(kind: SyntaxKind) -> bool

Returns true for a node with a SyntaxKind this type can wrap.

fn cast(node: SyntaxNode) -> Option<Self>

Try to cast a generic SyntaxNode into this typed wrapper.

fn syntax(&self) -> &SyntaxNode

Access the underlying SyntaxNode.

impl Clone for DocComment

fn clone(&self) -> DocComment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocComment

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

Formats the value using the given formatter.

impl Display for DocComment

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

Formats the value using the given formatter.

impl Eq for DocComment

impl Hash for DocComment

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

fn eq(&self, other: &DocComment) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocComment