rustdoc-text 0.3.3

A lightweight library and CLI tool to view Rust documentation as plain text
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
27
28
29
30
31
32
33
34

use anyhow::Result;
use clap::Parser;
use rustdoc_text::{fetch_local_docs, fetch_online_docs};

/// A tool to view Rust documentation as plain text in the terminal
#[derive(Parser, Debug)]
#[command(author, version, about, long_about = None)]
struct Args {
    /// The Rust crate name to fetch documentation for
    #[arg(index = 1)]
    crate_name: String,

    /// The item path within the crate (optional)
    #[arg(index = 2)]
    item_path: Option<String>,

    /// View the documentation from docs.rs instead of local build
    #[arg(short, long)]
    online: bool,
}

fn main() -> Result<()> {
    let args = Args::parse();

    let doc_content = if args.online {
        fetch_online_docs(&args.crate_name, args.item_path.as_deref())?
    } else {
        fetch_local_docs(&args.crate_name, args.item_path.as_deref())?
    };

    println!("{}", doc_content);

    Ok(())
}