adbook 0.1.0

Creates a book from AsciiDoc files
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

//! [`BookVisitor`] and a driving procedure of it

use {
    anyhow::Result,
    std::path::{Path, PathBuf},
};

use crate::book::toc::{Toc, TocItem, TocItemContent};

/// Converts each file in book
pub trait BookVisitor: Clone + Send + Sync {
    fn visit_file(&mut self, file: &Path) -> Result<()>;
}

pub fn flatten_toc_items(toc: &Toc, items: &mut Vec<TocItem>) {
    for item in &toc.items {
        match item.content {
            TocItemContent::File(_) => {
                items.push(item.clone());
            }
            TocItemContent::SubToc(ref toc) => {
                self::flatten_toc_items(toc, items);
            }
        };
    }
}

/// [Depth-first] iteration
///
/// [Depth-first]: https://en.wikipedia.org/wiki/Depth-first_search
pub fn pull_files_rec(toc: &Toc, files: &mut Vec<PathBuf>) {
    for item in &toc.items {
        match item.content {
            TocItemContent::File(ref file) => {
                files.push(file.clone());
            }
            TocItemContent::SubToc(ref toc) => {
                self::pull_files_rec(toc, files);
            }
        };
    }
}

/// Walks a root [`Toc`] and converts files one by one
pub fn walk_book(v: &mut impl BookVisitor, root_toc: &Toc) {
    let mut files = Vec::with_capacity(80);
    self::pull_files_rec(root_toc, &mut files);

    let results = files.iter().map(|file| v.visit_file(file));

    let errors: Vec<_> = results
        .into_iter()
        .filter(|x| x.is_err())
        .map(|x| x.unwrap_err())
        .collect();

    // print errors if any
    crate::utils::print_errors(&errors, "while building the book");
}

/// Walks a root [`Toc`] and converts files in parallel
pub async fn walk_book_async<V: BookVisitor + 'static>(v: &mut V, root_toc: &Toc) {
    let mut files = Vec::with_capacity(80);
    self::pull_files_rec(root_toc, &mut files);

    // collect `Future`s
    let xs = files.into_iter().map(|file| {
        let mut v = v.clone();
        // async move { v.visit_file(&file, &vcx) }
        async_std::task::spawn(async move { v.visit_file(&file) })
    });

    let results = futures::future::join_all(xs).await;

    let errors: Vec<_> = results
        .into_iter()
        .filter(|x| x.is_err())
        .map(|x| x.unwrap_err())
        .collect();

    crate::utils::print_errors(&errors, "while building the book");
}