cargo-doc-md 0.10.2

Cargo subcommand to generate markdown documentation for Rust crates and dependencies
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

//! JSON parser for rustdoc output.

use anyhow::{Context, Result};
use rustdoc_types::Crate;
use std::path::Path;

/// Load and parse a rustdoc JSON file.
pub fn load_rustdoc_json(path: &Path) -> Result<Crate> {
    let contents = std::fs::read_to_string(path)
        .with_context(|| format!("Failed to read file: {}", path.display()))?;

    let crate_data: Crate = serde_json::from_str(&contents)
        .with_context(|| format!("Failed to parse JSON from: {}", path.display()))?;

    println!(
        "Loaded crate: {} (format version: {})",
        crate_data
            .index
            .get(&crate_data.root)
            .and_then(|item| item.name.as_deref())
            .unwrap_or("unknown"),
        crate_data.format_version
    );

    Ok(crate_data)
}