file_io/
lib.rs

1//! [![github]](https://github.com/tamaskis/file_io) [![crates-io]](https://crates.io/crates/file-io) [![docs-rs]](https://docs.rs/file-io)
2//!
3//! [github]: https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github
4//! [crates-io]: https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust
5//! [docs-rs]: https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs
6//!
7//! Easy interfaces for file i/o.
8
9// Linter setup.
10#![warn(missing_docs)]
11
12// Module declarations.
13pub(crate) mod cd;
14pub(crate) mod copy;
15pub(crate) mod create;
16pub(crate) mod delete;
17pub(crate) mod list;
18pub(crate) mod load;
19pub(crate) mod modify;
20pub(crate) mod path;
21pub(crate) mod print;
22pub(crate) mod save;
23
24// Re-exports.
25pub use cd::{CdGuard, cd};
26pub use copy::{copy_file, copy_folder};
27pub use create::{create_folder, create_folder_for_file};
28pub use delete::{delete_file, delete_folder};
29pub use list::list_folder_contents;
30pub use load::load_file_as_string;
31pub use modify::{replace_str_in_file, replace_str_in_files};
32pub use path::{
33    get_cwd, get_file_extension, get_file_name, get_file_stem, get_home, get_last_path_component,
34    to_path_buf,
35};
36pub use print::print_folder_tree;
37pub use save::save_string_to_file;
38
39// Helper functions for unit testing.
40#[cfg(test)]
41pub(crate) mod test_utils;