Struct ModularApiReference 

pub struct ModularApiReference {
    pub crate_name: String,
    pub version: String,
    pub traits: Vec<TraitInfo>,
    pub types: Vec<TypeInfo>,
    pub examples: Vec<CodeExample>,
    pub cross_references: HashMap<String, Vec<String>>,
    pub metadata: ApiMetadata,
}

Complete API reference for a crate

Fields

crate_name: String

Name of the crate

version: String

Version of the crate

traits: Vec<TraitInfo>

Analyzed traits

types: Vec<TypeInfo>

Extracted type information

examples: Vec<CodeExample>

Code examples

cross_references: HashMap<String, Vec<String>>

Cross-references between API elements

metadata: ApiMetadata

Generation metadata

Implementations

impl ApiReference

pub fn to_json(&self) -> Result<String, SklearsError>

Convert to JSON representation

pub fn to_html(&self) -> Result<String, SklearsError>

Convert to HTML representation

pub fn to_markdown(&self) -> Result<String, SklearsError>

Convert to Markdown representation

pub fn to_interactive(&self) -> Result<String, SklearsError>

Generate interactive playground HTML

Trait Implementations

impl Clone for ApiReference

fn clone(&self) -> ApiReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiReference

fn deserialize<__D>( __deserializer: __D, ) -> Result<ApiReference, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiReference

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.