fs_extra

A Rust library that provides additional functionality not present in std::fs.

Documentation

Migrations to 1.x.x version

Key features:

• Copy files (optionally with information about the progress).

• Copy directories recursively (optionally with information about the progress).

• Move files (optionally with information about the progress).

• Move directories recursively (optionally with information about the progress).

• A single method for create and write String content in file.

• A single method for open and read String content from file.

• Get folder size

• Get collection of directory entries

Functions:

| Function | Description | | ------------- | ------------- | | fsextra::copyitems | Recursively copies files and directories from one location to another | | fsextra::copyitemswithprogress | Recursively copies files and directories from one location to another with information about progress | | fsextra::moveitems | Recursively moves files and directories from one location to another | | fsextra::moveitemswithprogress | Recursively moves files and directories from one location to another with information about progress | | fsextra::removeitems | Removes files or directories | | fsextra::file::copy | Copies the contents of one file to another | | fsextra::file::copywithprogress | Copies the contents of one file to another with information about progress | | fsextra::file::movefile | Moves a file from one location to another | | fsextra::file::movefilewithprogress | Moves a file from one location to another with information about progress | | fsextra::file::remove | Removes a file | | fsextra::file::readtostring | Reads file content into a String | | fsextra::file::writeall | Writes String content to a file | | fsextra::dir::create | Creates a new, empty directory at the given path | | fsextra::dir::createall | Recursively creates a directory and all of its parent components if they are missing | | fsextra::dir::copy | Recursively copies the directory contents from one location to another | | fsextra::dir::copywithprogress | Recursively copies the directory contents from one location to another with information about progress | | fsextra::dir::movedir | Moves directory contents from one location to another | | fsextra::dir::movedirwithprogress | Moves directory contents from one location to another with information about progress | | fsextra::dir::remove | Removes directory | | fsextra::dir::getsize | Returns the size of the file or directory | | fsextra::dir::getdircontent | Gets details such as the size and child items of a directory | | fsextra::dir::getdircontent2 | Gets details such as the size and child items of a directory using specified settings | | fsextra::dir::getdetailsentry | Gets attributes of a directory entry | | fsextra::dir::ls | Gets attributes of directory entries in a directory |

Usage

Add this to your Cargo.toml: toml [dependencies] fs_extra = "1.3.0"

Examples

The following example shows how to copy a directory recursively and display progress. First a source directory ./temp/dir containing file test1.txt and a subdirectory sub is createad with sub itself having a file test2.txt. ./temp/dir and all contents are then copied out to ./out/dir.

```rust use std::path::Path; use std::{thread, time}; use std::sync::mpsc::{self, TryRecvError};

extern crate fsextra; use fsextra::dir::; use fs_extra::error::;

fn example_copy() -> Result<()> {

let path_from = Path::new("./temp");
let path_to = path_from.join("out");
let test_folder = path_from.join("test_folder");
let dir = test_folder.join("dir");
let sub = dir.join("sub");
let file1 = dir.join("file1.txt");
let file2 = sub.join("file2.txt");

create_all(&sub, true)?;
create_all(&path_to, true)?;
fs_extra::file::write_all(&file1, "content1")?;
fs_extra::file::write_all(&file2, "content2")?;

assert!(dir.exists());
assert!(sub.exists());
assert!(file1.exists());
assert!(file2.exists());


let mut options = CopyOptions::new();
options.buffer_size = 1;
let (tx, rx) = mpsc::channel();
thread::spawn(move || {
    let handler = |process_info: TransitProcess| {
        tx.send(process_info).unwrap();
        thread::sleep(time::Duration::from_millis(500));
        fs_extra::dir::TransitProcessResult::ContinueOrAbort
    };
    copy_with_progress(&test_folder, &path_to, &options, handler).unwrap();
});

loop {
    match rx.try_recv() {
        Ok(process_info) => {
            println!("{} of {} bytes",
                     process_info.copied_bytes,
                     process_info.total_bytes);
        }
        Err(TryRecvError::Disconnected) => {
            println!("finished");
            break;
        }
        Err(TryRecvError::Empty) => {}
    }
}
Ok(())

} fn main() { example_copy(); } ```