taboc 0.2.105

A table of contents generator for markdown documents.
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

#![doc = include_str!("../README.md")]
///////////////////////////////////////////////////////////////////////////////////////////////////
// Correctness
///////////////////////////////////////////////////////////////////////////////////////////////////
#![warn(rust_2018_idioms, reason = "Deprecated practices.")]
#![warn(clippy::unused_async, reason = "Remove unnecessary overhead.")]
#![warn(clippy::rc_mutex, reason = "`Rc<RefCell<T>>` is more appropriate.")]
#![warn(
    clippy::unwrap_in_result,
    reason = "Preferably map errors in order to not panic but rather return the error value gracefully."
)]
#![warn(clippy::expect_used, reason = "Prefer errors as values.")]
#![deny(clippy::unwrap_used, reason = "Prefer errors as values.")]
#![warn(
    clippy::mutex_atomic,
    reason = "Prefer using atomics where possible for less contention."
)]
#![deny(
    clippy::mutex_integer,
    reason = "Prefer using atomics where possible for less contention."
)]
#![warn(
    clippy::empty_enum_variants_with_brackets,
    reason = "Unnecessary to use."
)]
#![warn(
    clippy::redundant_pub_crate,
    reason = "Can mess up crate visibility when working with imports."
)]
#![warn(
    clippy::cloned_instead_of_copied,
    reason = "Prefer explicitly indicating types that implement `Copy` for iterators."
)]
#![deny(
    clippy::semicolon_if_nothing_returned,
    reason = "Bad practice. If nothing is returned then it's better to specify that, rather than rely on the return value of another function that also happens to return `()`."
)]
#![deny(
    clippy::redundant_clone,
    reason = "Potential performance issues and correctness."
)]
#![deny(
    clippy::used_underscore_binding,
    reason = "Underscore bindings indicate unused variables in Rust. (Unlike languages like C which use them for private variables)."
)]
#![deny(
    clippy::expl_impl_clone_on_copy,
    reason = "`Copy` is a supertrait of `Clone`."
)]
#![deny(
    clippy::clone_on_ref_ptr,
    reason = "When working with `Rc` and `Arc`, prefer explicitly cloning with `Rc::clone()` or `Arc::clone()` to indicate that the clone is a reference counter one."
)]
///////////////////////////////////////////////////////////////////////////////////////////////////
// Application specific
///////////////////////////////////////////////////////////////////////////////////////////////////
#![deny(
    clippy::infinite_loop,
    reason = "This program shouldn't directly contain any infinite loops!"
)]
///////////////////////////////////////////////////////////////////////////////////////////////////
// Conciseness
///////////////////////////////////////////////////////////////////////////////////////////////////
#![warn(clippy::struct_field_names, reason = "Unnecessary text.")]
#![warn(clippy::manual_let_else, reason = "More succinct.")]
#![warn(
    clippy::unnecessary_join,
    reason = "More succinct. Although sometimes useful to do."
)]
#![warn(clippy::redundant_closure_for_method_calls, reason = "More concise.")]
#![warn(
    clippy::if_then_some_else_none,
    reason = "Conciseness and readability."
)]
#![warn(clippy::explicit_into_iter_loop, reason = "Readability.")]
#![deny(clippy::redundant_else, reason = "Readability.")]
#![deny(clippy::string_to_string, reason = "Redundant.")]
#![deny(clippy::get_unwrap, reason = "Prefer direct indexing for conciseness.")]

/*!
# Minimal example

If you wish to use this project as a library, all you need to have as a script is:

```
std::env::set_var("RUSTDOC_TEST_ARGS", "--no-file-update");

use taboc::app::App;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    App::init()?.run()?;

    Ok(())
}
```
*/

/// The user-facing logic of the program.
pub mod app;

/// Re-exports. Mainly for internal usage. Could be ambiguous.
pub mod prelude;

/// Crate utilities. Can be used independently if needed.
pub mod utils;

/// Crate tests.
#[doc(hidden)]
#[cfg(test)]
mod tests;