fs-more

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.),
optionally, copying and moving files or directories with progress reporting,
scanning directories with depth and other options, and
calculating file or directory sizes.

Usage

To add fs-more into your project, specify it in your Cargo.toml file:

fs-more = "0.3.0"

Examples

Copying a file and getting updates on the progress:

use std::path::Path;
use fs_more::error::FileError;
use fs_more::file::FileCopyWithProgressOptions;

let source_path = Path::new("./source-file.txt");
let target_path = Path::new("./target-file.txt");

let bytes_copied = 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);
    }
)?;

println!("Copied {bytes_copied} bytes!");

Moving a directory and getting updates on the progress:

use std::path::Path;
use fs_more::error::DirectoryError;
use fs_more::directory::DirectoryMoveWithProgressOptions;
use fs_more::directory::TargetDirectoryRule;

let source_path = Path::new("./source-directory");
let target_path = Path::new("./target-directory");

let moved = 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
        );
    }
)?;

println!(
    "Moved {} bytes ({} files, {} directories)! Used the {:?} strategy.",
    moved.total_bytes_moved,
    moved.num_files_moved,
    moved.num_directories_moved,
    moved.used_strategy
);

Feature flags

The following feature flags are available:

fs-err: enables fs-err support, which means more helpful underlying IO error messages (though fs-more already provides many on its own).
miette: derives miette::Diagnostic on all error types, allowing users to conveniently e.g. wrap_err_with.

Project status

This crate lacks some more thorough battle-testing. As such, use it with reasonable caution and testing.

Most features have been added, but it is possible some smaller ones will turn up missing. For now, I plan on keeping the version below 1.0.0 to imply that this hasn't gone though a lot.

However, quite a few unit, doc- and integration tests have been written. They cover a wide array of the base functionality, but fringe cases might not be covered yet — contributions are welcome!

Contributing and development

Want to contribute? Awesome! Start by going over the contribution guide: CONTRIBUTING.md.

Attribution

fs-more isn't a fork, but has been inspired by some of the functionalities of the fs_extra library (thank you!).

fs-more 0.3.0