Struct RustDocExtensions 

pub struct RustDocExtensions {
    pub is_module_doc: bool,
    pub is_unsafe: bool,
    pub returns_result: bool,
    pub is_async: bool,
    pub panics: Vec<String>,
    pub errors: Vec<String>,
    pub safety: Vec<String>,
    pub type_params: Vec<(String, Option<String>)>,
    pub doc_links: Vec<String>,
    pub must_use: Option<String>,
    pub deprecated_since: Option<String>,
    pub feature_gate: Option<String>,
}

@acp:summary “Rust-specific extensions for doc comments”

Fields

is_module_doc: bool

Whether this is module-level documentation (//!)

is_unsafe: bool

Whether the item is marked unsafe

returns_result: bool

Whether the item returns a Result type

is_async: bool

Whether the item is async

panics: Vec<String>

Panic conditions

errors: Vec<String>

Error conditions (for Result types)

safety: Vec<String>

Safety requirements (for unsafe code)

type_params: Vec<(String, Option<String>)>

Type parameters with descriptions

doc_links: Vec<String>

Intra-doc links found

must_use: Option<String>

Whether marked with #[must_use]

deprecated_since: Option<String>

Deprecation info (since, note)

feature_gate: Option<String>

Feature gate if any

Trait Implementations

impl Clone for RustDocExtensions

fn clone(&self) -> RustDocExtensions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RustDocExtensions

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

Formats the value using the given formatter.

impl Default for RustDocExtensions

fn default() -> RustDocExtensions

Returns the “default value” for a type.