Struct InteractiveAPIReference 

pub struct InteractiveAPIReference {
    pub traits: HashMap<String, DocumentedTrait>,
    pub types: HashMap<String, DocumentedType>,
    pub functions: HashMap<String, DocumentedFunction>,
    pub search_index: SearchIndex,
    pub config: APIReferenceConfig,
}

Interactive API reference generator

Generates comprehensive, interactive API documentation with search, filtering, and live code examples.

Fields

traits: HashMap<String, DocumentedTrait>

All documented traits

types: HashMap<String, DocumentedType>

All documented types

functions: HashMap<String, DocumentedFunction>

All documented functions

search_index: SearchIndex

Search index for fast lookups

config: APIReferenceConfig

Configuration

Implementations

impl InteractiveAPIReference

pub fn new() -> Self

Create a new API reference

pub fn add_trait(&mut self, trait_doc: DocumentedTrait)

Add a documented trait

pub fn add_type(&mut self, type_doc: DocumentedType)

Add a documented type

pub fn add_function(&mut self, func_doc: DocumentedFunction)

Add a documented function

pub fn search(&self, query: &str) -> SearchResults

Search the API reference

pub fn generate_html(&self) -> String

Generate HTML documentation

Trait Implementations

impl Clone for InteractiveAPIReference

fn clone(&self) -> InteractiveAPIReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InteractiveAPIReference

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

Formats the value using the given formatter.

impl Default for InteractiveAPIReference

fn default() -> Self

Returns the “default value” for a type.