Struct Declaration 

struct Declaration {
    path: String,
    summary: Option<String>,
    unreadable: Option<String>,
}

A public type declaration: what a summary and a source citation come from.

Fields

path: String

The file it is declared in, repository-relative.

summary: Option<String>

Its first doc paragraph, if it has one and it could be read.

unreadable: Option<String>

Why its doc comment could not be read, when that is what happened.

Carried rather than discarded. doc_summary fails when a doc comment carries a link the Markdown rewrite refuses to classify, and collapsing that Err into None made summary_for report the one diagnosis that is certainly wrong — “has no doc comment”, about a type whose doc comment is right there (§1.3.152).

Trait Implementations

impl Clone for Declaration

fn clone(&self) -> Declaration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Declaration

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

Formats the value using the given formatter.