Struct BridgeResult 

pub struct BridgeResult {
    pub summary: Option<String>,
    pub directive: Option<String>,
    pub params: Vec<ParamEntry>,
    pub returns: Option<ReturnsEntry>,
    pub throws: Vec<ThrowsEntry>,
    pub examples: Vec<String>,
    pub source: BridgeSource,
    pub source_formats: Vec<SourceFormat>,
}

@acp:summary “Result of bridging native documentation with ACP annotations”

Fields

summary: Option<String>

Merged summary/description

directive: Option<String>

AI behavioral directive for the function/method

params: Vec<ParamEntry>

Parameter entries with provenance

returns: Option<ReturnsEntry>

Returns entry with provenance

throws: Vec<ThrowsEntry>

Throws entries with provenance

examples: Vec<String>

Examples extracted from documentation

source: BridgeSource

Overall source of the merged documentation

source_formats: Vec<SourceFormat>

Source formats that contributed to this result

Implementations

impl BridgeResult

pub fn new() -> Self

@acp:summary “Create a new empty bridge result”

pub fn from_acp(summary: Option<String>, directive: Option<String>) -> Self

@acp:summary “Create from pure ACP annotations (explicit source)”

pub fn from_native(parsed: &ParsedDocumentation, format: SourceFormat) -> Self

@acp:summary “Create from converted native documentation”

Trait Implementations

impl Clone for BridgeResult

fn clone(&self) -> BridgeResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BridgeResult

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

Formats the value using the given formatter.

impl Default for BridgeResult

fn default() -> BridgeResult

Returns the “default value” for a type.