Struct DocExtraction 

pub struct DocExtraction {
    pub markdown_path: PathBuf,
    pub content: String,
    pub source_location: String,
}

Represents a documentation extraction with its target path and metadata

Fields

markdown_path: PathBuf

Path where the markdown file should be written

content: String

The documentation content to write

source_location: String

Source location in file:line format

Implementations

impl DocExtraction

pub fn new( markdown_path: PathBuf, content: String, source_location: String, ) -> Self

Creates a new DocExtraction and ensures content ends with a newline

Trait Implementations

impl Clone for DocExtraction

fn clone(&self) -> DocExtraction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocExtraction

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

Formats the value using the given formatter.

impl PartialEq for DocExtraction

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DocExtraction