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

//! Convenient file and directory operations built on top of [`std::fs`] with improved error handling.
//! Includes copying / moving files and directories with progress reporting.
//!
//! ## Main features
//! - copying and moving files or directories with in-depth configuration options (including IO buffering settings, copying depth, etc.)
//! - copying and moving files (or directories) **with progress reporting**,
//! - scanning directories with depth and other options, and
//! - calculating file or directory sizes.
//!
//! To start off, visit the [`directory`][crate::directory] and [`file`][crate::file] modules
//! for more information and a list of functions.
//!
//!
//! <br>
//!
//! ## Feature flags
//! The following feature flags are available:
//! - `fs-err`: enables the optional [`fs-err`](../fs_err) support, enabling more helpful underlying IO error messages
//!   (though `fs-more` already provides many on its own).
//!
//! <br>
//!
//! ## Examples
//!
//! Copying a file with a progress handler:
//! ```no_run
//! # use std::path::Path;
//! # use fs_more::error::FileError;
//! # use fs_more::file::FileCopyWithProgressOptions;
//! # fn main() -> Result<(), FileError> {
//! let source_path = Path::new("./source-file.txt");
//! let target_path = Path::new("./target-file.txt");
//!
//! let copy_result = fs_more::file::copy_file_with_progress(
//!     source_path,
//!     target_path,
//!     FileCopyWithProgressOptions::default(),
//!     |progress| {
//!         let percent_copied =
//!             (progress.bytes_finished as f64) / (progress.bytes_total as f64)
//!             * 100.0;
//!
//!         println!("Copied {:.2}% of the file!", percent_copied);
//!     }
//! )?;
//! # Ok(())
//! # }
//! ```
//!
//! Moving a directory with a progress handler:
//! ```no_run
//! # use std::path::Path;
//! # use fs_more::error::DirectoryError;
//! # use fs_more::directory::DirectoryMoveWithProgressOptions;
//! # use fs_more::directory::TargetDirectoryRule;
//! # fn main() -> Result<(), DirectoryError> {
//! let source_path = Path::new("./source-directory");
//! let target_path = Path::new("./target-directory");
//!
//! let move_result = fs_more::directory::move_directory_with_progress(
//!     source_path,
//!     target_path,
//!     DirectoryMoveWithProgressOptions {
//!         target_directory_rule: TargetDirectoryRule::AllowEmpty,
//!         ..Default::default()
//!     },
//!     |progress| {
//!         let percent_moved =
//!             (progress.bytes_finished as f64) / (progress.bytes_total as f64)
//!             * 100.0;
//!
//!         println!(
//!             "Moved {:.2}% of the directory ({} files and {} directories so far).",
//!             percent_moved,
//!             progress.files_moved,
//!             progress.directories_created
//!         );
//!     }
//! )?;
//! # Ok(())
//! # }
//! ```
//!
//! <br>
//!
//! ## Attribution
//!
//! <details>
//! <summary>Inspired by <code>fs_extra</code></summary>
//!
//! `fs-more` isn't a fork, but has been inspired by
//! some of the functionalities of the [`fs_extra`](https://github.com/webdesus/fs_extra) library (thank you!).
//!
//! </details>
//!

#![deny(missing_docs)]

pub mod directory;
pub mod error;
pub mod file;