build_fs_tree/
lib.rs

1//! # [`FileSystemTree`]
2//!
3//! [`FileSystemTree::build`](Build::build) is faster than
4//! [`MergeableFileSystemTree::build`](MergeableFileSystemTree) but it does not write over an existing
5//! directory and it does not create parent directories when they don't exist.
6//!
7//! **Example:**
8//!
9//! ```no_run
10//! use build_fs_tree::{FileSystemTree, Build, dir, file};
11//! let tree: FileSystemTree<&str, &str> = dir! {
12//!     "index.html" => file!(r#"
13//!         <!DOCTYPE html>
14//!         <link rel="stylesheet" href="styles/style.css" />
15//!         <script src="scripts/main.js"></script>
16//!     "#)
17//!     "scripts" => dir! {
18//!         "main.js" => file!(r#"document.write('Hello World')"#)
19//!     }
20//!     "styles" => dir! {
21//!         "style.css" => file!(r#":root { color: red; }"#)
22//!     }
23//! };
24//! tree.build("public").unwrap();
25//! ```
26//!
27//! # [`MergeableFileSystemTree`]
28//!
29//! Unlike [`FileSystemTree::build`](FileSystemTree), [`MergeableFileSystemTree::build`](Build::build)
30//! can write over an existing directory and create parent directories that were not exist before at the
31//! cost of performance.
32//!
33//! You can convert a `FileSystemTree` into a `MergeableFileSystemTree` via [`From::from`]/[`Into::into`]
34//! and vice versa.
35//!
36//! **Example:**
37//!
38//! ```no_run
39//! use build_fs_tree::{MergeableFileSystemTree, Build, dir, file};
40//! let tree = MergeableFileSystemTree::<&str, &str>::from(dir! {
41//!     "public" => dir! {
42//!         "index.html" => file!(r#"
43//!             <!DOCTYPE html>
44//!             <link rel="stylesheet" href="styles/style.css" />
45//!             <script src="scripts/main.js"></script>
46//!         "#)
47//!         "scripts/main.js" => file!(r#"document.write('Hello World')"#)
48//!         "scripts/style.css" => file!(r#":root { color: red; }"#)
49//!     }
50//! });
51//! tree.build(".").unwrap();
52//! ```
53//!
54//! # Serialization and Deserialization
55//!
56//! Both [`FileSystemTree`] and [`MergeableFileSystemTree`] implement [`serde::Deserialize`]
57//! and [`serde::Serialize`].
58
59#![deny(warnings)]
60
61mod build;
62mod macros;
63mod node;
64mod tree;
65
66pub use build::*;
67pub use node::*;
68pub use tree::*;
69
70#[cfg(feature = "cli")]
71pub mod program;
72
73pub use serde;
74pub use serde_yaml;
build_fs_tree/lib.rs

build_fs_tree/
lib.rs
