Expand description
Core Data Structures for API Reference Generation
This module contains all the data structures used by the API reference generator, including trait information, type definitions, code examples, and interactive documentation components.
Structs§
- ApiMetadata
- Metadata about the API reference generation
- ApiReference
- Complete API reference for a crate
- ApiVisualization
- API visualization
- ApiVisualization
Data - Data for API visualizations
- Associated
Type - Information about an associated type
- Auto
Complete Engine - Auto-complete engine
- Code
Example - Code example extracted from documentation
- Completion
Node - Completion node
- Completion
Stats - Completion statistics
- Crate
Info - Information about a crate
- Enhanced
Search Index - Enhanced search index with multiple search engines
- Example
Visualization - Visualization for code examples
- Execution
Result - Result of code execution
- Field
Info - Information about a field or enum variant
- Interactive
Documentation - Interactive documentation with live examples and features
- Interactive
Element - Interactive element for examples
- Interactive
Tutorial - Interactive tutorial
- Live
Code Example - Live code example with execution capabilities
- Method
Info - Information about a method
- Parameter
Info - Information about a method parameter
- Search
Analytics - Search analytics
- Search
Index - Search index for API elements
- Search
Item - Individual search item
- Search
Metadata - Search metadata
- Search
Performance Metrics - Search performance metrics
- Semantic
Model Config - Configuration for semantic search models
- Semantic
Search Engine - Semantic search engine
- Similarity
Search Engine - Similarity search engine
- Trait
Info - Information about a trait
- Tutorial
Step - Individual tutorial step
- Tutorial
Template - Template for generating tutorials
- Type
Info - Information about a type
- Type
Search Engine - Type-based search engine
- Type
Signature - Type signature information
- UIComponent
- UI component for interactive features
- Usage
Pattern - Usage pattern information
- Usage
Pattern Search Engine - Usage pattern search engine
- Visualization
Config - Configuration for visualizations
- Visualization
Edge - Edge in a visualization
- Visualization
Node - Node in a visualization
- Wasm
Binding - WASM binding for Rust code
- Wasm
Method - WASM method binding
- Wasm
Playground - WebAssembly playground configuration
Enums§
- Completion
Type - Types of completions
- Interactive
Element Type - Types of interactive elements
- Pattern
Type - Types of usage patterns
- Search
Item Type - Types of searchable items
- Similarity
Algorithm - Similarity algorithms
- Tutorial
Difficulty - Tutorial difficulty levels
- Type
Kind - Kind of type definition
- UIComponent
Type - Types of UI components
- Visibility
- Visibility levels
- Visualization
Type - Types of visualizations