Struct CopyBuilder

pub struct CopyBuilder {
    pub source: PathBuf,
    pub destination: PathBuf,
    /* private fields */
}

Recursively copy a directory from a to b.

use dircpy::*;

// Most basic example:
copy_dir("src", "dest");

// Simple builder example:
CopyBuilder::new("src", "dest")
.run()
.unwrap();

// Copy recursively, only including certain files:
CopyBuilder::new("src", "dest")
.overwrite_if_newer(true)
.overwrite_if_size_differs(true)
.with_include_filter(".txt")
.with_include_filter(".csv")
.run()
.unwrap();

Fields

source: PathBuf

The source directory

destination: PathBuf

The destination directory

Implementations

impl CopyBuilder

pub fn new<P: AsRef<Path>, Q: AsRef<Path>>(source: P, dest: Q) -> CopyBuilder

Construct a new CopyBuilder with source and dest.

pub fn overwrite(self, overwrite: bool) -> CopyBuilder

Overwrite target files (off by default)

pub fn overwrite_if_newer(self, overwrite_only_newer: bool) -> CopyBuilder

Overwrite if the source is newer (off by default)

pub fn overwrite_if_size_differs( self, overwrite_if_size_differs: bool, ) -> CopyBuilder

Overwrite if size between source and dest differs (off by default)

pub fn with_exclude_filter(self, f: &str) -> CopyBuilder

Do not copy files that contain this string

pub fn with_include_filter(self, f: &str) -> CopyBuilder

Only copy files that contain this string.

pub fn run(&self) -> Result<(), Error>

Execute the copy operation

pub fn run_par(&self) -> Result<(), Error>

Execute the copy operation in parallel. The usage of this function is discouraged until proven to work faster.

Trait Implementations

impl Clone for CopyBuilder

fn clone(&self) -> CopyBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CopyBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.