rusty-man 0.5.0

Command-line viewer for rustdoc 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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

// SPDX-FileCopyrightText: 2020 Robin Krahl <robin.krahl@ireas.org>
// SPDX-License-Identifier: MIT

mod text;
mod tui;
mod utils;

use std::fmt;
use std::io;

use crate::args;
use crate::doc;
use crate::source;

pub trait Viewer: fmt::Debug {
    fn open(
        &self,
        sources: source::Sources,
        args: args::ViewerArgs,
        doc: &doc::Doc,
    ) -> anyhow::Result<()>;

    fn open_examples(
        &self,
        sources: source::Sources,
        args: args::ViewerArgs,
        doc: &doc::Doc,
        examples: Vec<doc::Example>,
    ) -> anyhow::Result<()>;
}

pub fn get_viewer(s: &str) -> anyhow::Result<Box<dyn Viewer>> {
    let viewer: Box<dyn Viewer> = match s.to_lowercase().as_ref() {
        "plain" => Box::new(text::TextViewer::new(text::TextMode::Plain)),
        "rich" => Box::new(text::TextViewer::new(text::TextMode::Rich)),
        "tui" => Box::new(tui::TuiViewer::new()),
        _ => anyhow::bail!("The viewer {} is not supported", s),
    };
    Ok(viewer)
}

pub fn get_default() -> Box<dyn Viewer> {
    let text_mode = if termion::is_tty(&io::stdout()) {
        text::TextMode::Rich
    } else {
        text::TextMode::Plain
    };
    Box::new(text::TextViewer::new(text_mode))
}