How to copy a directory with progress bar in Rust using fs_extra?

Use the copy_items_with_progress function with a callback handler to monitor progress; the README includes an example that spawns a thread to display copied bytes and total bytes during the operation.

fs_extra vs std::fs: which is better for file operations?

Choose fs_extra if you need recursive copying, progress tracking, or simplified string I/O; otherwise, std::fs is sufficient for basic tasks and avoids an extra dependency.

How to get folder size recursively with fs_extra?

Call the dir::get_size function with the directory path; it recursively calculates the total size in bytes, useful for disk usage analysis.

Does fs_extra support symbolic links or hard links?

The README doesn't explicitly mention link handling, so it likely relies on std::fs behavior; check the documentation for specifics, but it may not offer dedicated utilities for links.

How to move multiple files at once with fs_extra?

Use the move_items function to recursively move files and directories from a source list to a destination, with options to control overwrite and other settings.

What error types does fs_extra use, and how to handle them?

Functions return Result types from the error module; handle errors using Rust's standard patterns like match or the ? operator, as shown in the example code.

fs_extra

MITRust1.3.0

A Rust library extending std::fs and std::io with advanced file and directory operations like copy, move, and progress tracking.

GitHub

334 stars55 forks0 contributors

What is fs_extra?

fs_extra is a Rust library that extends the standard library's `std::fs` and `std::io` modules with additional file system operations. It provides more powerful and convenient methods for common tasks like recursively copying or moving directories, reading/writing strings to files, and tracking progress during file transfers. The library fills gaps in Rust's built-in file management, making it more comprehensive for real-world use.

Target Audience

Rust developers who need enhanced file system operations beyond what `std::fs` offers, such as those building applications that involve file management, data migration, or backup tools. It is particularly useful for developers requiring progress tracking, recursive directory operations, or simplified file content handling.

Value Proposition

Developers choose fs_extra over manually implementing these features because it provides a unified, well-tested API for operations missing from Rust's standard library, like progress-aware file transfers and recursive directory management. Its unique selling point is the combination of convenience methods and progress tracking callbacks, reducing boilerplate code and improving user experience in file-intensive applications.

Overview

Expanding opportunities standard library std::fs and std::io

Use Cases

Best For

Related Projects

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub

Recursively copying or moving directories with real-time progress updates, such as in backup or synchronization tools.
Simplifying file content I/O by reading or writing entire strings to files with single method calls, avoiding manual buffer management.
Calculating folder sizes and retrieving detailed directory contents for disk usage analysis or file system explorers.
Performing batch file operations like removing multiple items or copying entire directory trees in Rust applications.
Building command-line utilities or GUI applications that require progress feedback during long file transfers.
Extending Rust's standard file system capabilities in projects where `std::fs` lacks built-in support for recursive or progress-tracked operations.

Not Ideal For

Projects where minimizing dependencies is critical and std::fs covers all needed file operations
Applications requiring asynchronous file I/O or advanced features like inotify integration
High-performance systems where the overhead of progress callbacks is unacceptable for simple tasks
Teams already invested in alternative Rust file utility crates with broader ecosystem support

Pros & Cons

Pros

Recursive Operations with Progress

Provides functions like copy_items_with_progress and move_items_with_progress for recursive directory operations with real-time progress updates, eliminating the need for manual implementation of complex file transfers.

Simplified File I/O

Offers single-method utilities such as file::read_to_string and file::write_all for reading and writing string content to files, reducing boilerplate code compared to std::fs.

Comprehensive Directory Management

Includes tools like dir::get_size and dir::get_dir_content for calculating folder sizes and listing directory entries with details, which are not natively available in Rust's standard library.

Well-Documented API

Features extensive documentation on docs.rs with a clear function table and examples in the README, making it easy for developers to integrate and use.

Cons

Breaking Changes

The README highlights 'Migrations to 1.x.x version,' indicating that major updates can introduce breaking changes, requiring code adjustments and potentially disrupting existing projects.

Limited Feature Scope

Focuses on extending std::fs but lacks support for advanced file system operations like symbolic link handling or async I/O, which may be necessary for modern applications.

Performance Trade-offs

Progress tracking callbacks add runtime overhead, which can be inefficient for simple file operations where std::fs would suffice without extra complexity.

Frequently Asked Questions

Home

Rust

OpenDAL

Apache OpenDAL: One Layer, All Storage.

Stars5,062

Forks749

Last commit14 hours ago

zbox

Zero-details, privacy-focused in-app file system.

Stars1,540

Forks85

Last commit2 years ago

tempfile

Temporary file library for rust

Stars1,428

Forks146

Last commit9 days ago

Camino

Like Rust's std::path::Path, but UTF-8.

Stars557

Forks25

Last commit1 month ago