Struct DocCommentBlock 

pub struct DocCommentBlock {
    pub kind: DocCommentKind,
    pub start_line: usize,
    pub end_line: usize,
    pub byte_start: usize,
    pub byte_end: usize,
    pub markdown: String,
    pub line_metadata: Vec<DocCommentLineInfo>,
    pub prefix_byte_lengths: Vec<usize>,
}

A contiguous block of same-kind doc comments extracted from a Rust source file.

Fields

kind: DocCommentKind

Whether this is an outer (///) or inner (//!) doc comment.

start_line: usize

0-indexed line number of the first line in the original file.

end_line: usize

0-indexed line number of the last line in the original file (inclusive).

byte_start: usize

Byte offset of the first character of the first line in the block.

byte_end: usize

Byte offset past the last character (including \n) of the last line in the block.

markdown: String

Extracted markdown content with prefixes stripped.

line_metadata: Vec<DocCommentLineInfo>

Per-line metadata for prefix restoration during fix mode.

prefix_byte_lengths: Vec<usize>

Length of leading whitespace + prefix (in bytes) for column offset remapping. Each entry corresponds to a line in line_metadata.

Trait Implementations

impl Clone for DocCommentBlock

fn clone(&self) -> DocCommentBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocCommentBlock

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

Formats the value using the given formatter.