Struct FileCopyWithProgressOptions

pub struct FileCopyWithProgressOptions {
    pub colliding_file_behaviour: CollidingFileBehaviour,
    pub read_buffer_size: usize,
    pub write_buffer_size: usize,
    pub progress_update_byte_interval: u64,
}

Options that influence the copy_file_with_progress function.

Fields

colliding_file_behaviour: CollidingFileBehaviour

How to behave when the destination file already exists.

read_buffer_size: usize

Internal buffer size used for reading the source file.

Defaults to 64 KiB.

write_buffer_size: usize

Internal buffer size used for writing to the destination file.

Defaults to 64 KiB.

progress_update_byte_interval: u64

The smallest number of bytes copied between two consecutive progress reports.

Increase this value to make progress reports less frequent, and decrease it to make them more frequent. Keep in mind that decreasing the interval will likely come at some performance cost, depending on your progress handling closure.

Note that this is the minimum interval. The actual reporting interval may be larger! Consult copy_file_with_progress documentation for more details.

Defaults to 512 KiB.

Trait Implementations

impl Clone for FileCopyWithProgressOptions

fn clone(&self) -> FileCopyWithProgressOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileCopyWithProgressOptions

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

Formats the value using the given formatter.

impl Default for FileCopyWithProgressOptions

fn default() -> Self

Constructs relatively safe defaults for copying a file:

• aborts if there is an existing destination file (CollidingFileBehaviour::Abort),
• sets buffer size for reading and writing to 64 KiB, and
• sets the progress update closure call interval to 512 KiB.

impl PartialEq for FileCopyWithProgressOptions

fn eq(&self, other: &FileCopyWithProgressOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for FileCopyWithProgressOptions

impl Eq for FileCopyWithProgressOptions

impl StructuralPartialEq for FileCopyWithProgressOptions