cargo-modules 0.12.0

A cargo plugin for showing a tree-like overview of a crate's modules.
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
50
51
52
53
54
55
56
57
58
59
60
61
62

// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

use std::fmt::Write;

use log::trace;
use ra_ap_hir as hir;
use ra_ap_ide::RootDatabase;
use ra_ap_vfs::Vfs;

use crate::tree::{
    builder::{Builder, Options as BuilderOptions},
    filter::{Filter, Options as FilterOptions},
    printer::{Options as PrinterOptions, Printer},
};

pub struct Command {
    builder_options: BuilderOptions,
    filter_options: FilterOptions,
    printer_options: PrinterOptions,
}

impl Command {
    pub fn new(
        builder_options: BuilderOptions,
        filter_options: FilterOptions,
        printer_options: PrinterOptions,
    ) -> Self {
        Self {
            builder_options,
            filter_options,
            printer_options,
        }
    }

    #[doc(hidden)]
    pub fn run(self, krate: hir::Crate, db: &RootDatabase, vfs: &Vfs) -> anyhow::Result<()> {
        trace!("Building tree ...");

        let builder = Builder::new(self.builder_options, db, vfs, krate);
        let tree = builder.build()?;

        trace!("Filtering tree ...");

        let filter = Filter::new(self.filter_options, db, krate);
        let tree = filter.filter(&tree)?;

        trace!("Printing tree ...");

        let mut string = String::new();

        writeln!(&mut string)?;

        let printer = Printer::new(self.printer_options, db);
        printer.fmt(&mut string, &tree)?;

        print!("{string}");

        Ok(())
    }
}