fs-more v0.5.0

This is a rather big (and breaking) release - a substantial amount of the API surface has been reworked.

Several structs and enums have been renamed or changed, and several were freshly introduced;
this will mean having to manually go through a bit of code to migrate if you're on v0.4.0.
This changelog likely doesn't cover all of the changes that the crate got, but hopefully most of them.

Added

• The dunce feature flag is now available and enabled by default. It brings in the dunce crate, which automatically strips Windows' UNC paths if they can be represented using the usual type of path (e.g. \\?\C:\foo -> C:\foo). This is used both internally and in e.g. DirectoryScan's file and directory paths. This feature flag is enabled by default and recommended because path canonicalization very commonly returns UNC paths. This crate only has an effect when compiling for Windows targets.
• fs-more is now available under the Apache-2.0 license as well! Our new license expression is therefore MIT OR Apache-2.0.
• Several options throughout the crate have been refactored, for example:
  • When copying a directory, you can specify whether you allow the destination directory to exist, and if so, whether it can be non-empty (this is not new). What is new is that you can more precisely specify what actions to take when encountering file or subdirectory collisions (see DestinationDirectoryRule).
• Behaviour with symbolic links for all functions has been reviewed (and added to integration tests), and the relevant documentation has been updated.
• DirectoryScan now has a standalone options struct, and its symlink behaviour has received more testing.
• Several file-related functions, such as copy_file, now return a standalone struct (e.g. FileCopyFinished) containing additional context about the actions performed, such as whether the file was created, overwritten, or skipped.
• Error types now have better documentation, including explanations for common errors in the documentation on main functions themselves (see e.g. copy_directory_with_progress).

Changed

• fs-more's MSRV has been increased to 1.77.0 due to our use of File::create_new.
• Most mentions of a "target" file or directory are now referred to as a "destination" file or directory.
• The buffer sizes for reading and writing have been split from one into two options.
• The progress update interval's default value of 64 KiB has been increased to a larger, and not really any less useful, 512 KiB, to avoid potential performance problems. Calling a closure every 64 KiB can be either excessive or a choice, but it's definitely not a good default.
• The error types have been fully overhauled and now allow much better insight into the actual error type as well as context surrounding it. Some would probably say that the error types are actually too complex, but a middle ground seems hard to achieve. So for now, when in doubt, just convert them into generic errors with e.g. dyn Error trait objects or miette's into_diagnostic.
• The testing harness has received a full overhaul. Not only are there more assertions available for easier testing, but the filesystem tree harness has been fully rewritten: we now declare the file tree in a JSON file, and the corresponding Rust code is generated from that schema. Each tree harness is responsible for temporarily initializing the file tree, and allows us to inspect individual components. More details are available in CONTRIBUTING.md.
• To create a consistent naming scheme, several structs have been renamed. Previously, things like FinishedDirectoryMove existed, but now we adhere to [type][operation][name], e.g. FileMoveOptions. Examples:
  • TargetDirectoryRule has been renamed to DestinationDirectoryRule.
  • FinishedDirectoryCopy has been renamed to DirectoryCopyFinished.
  • FinishedDirectoryMove has been renamed to DirectoryMoveFinished.
  • DirectoryCopyProgress has been renamed to DirectoryCopyProgressRef
    (DirectoryCopyProgress exists in this version, but that's an owned version of DirectoryCopyProgressRef).
• Several field names have been reworded, e.g. num_files_copied is now files_copied.
• DirectoryScan no longer exposes the files and directories fields directly - see the files() and directories() methods instead.
• Depth limits are now generally enums, not Option<usize> (see CopyDirectoryDepthLimit, among others).
• Many internals have been reorganised for easier maintainability and less code repetition.
• Integration tests have been reorganised from separate binaries into a single integration binary for compilation speed. Additionally, the tests have been restructured into smaller modules for clarity.

Removed

• The miette feature flag has been removed. It previously just derived Diagnostic on all error types, we did not take advantage of anything that the end user could not do with into_diagnostic themselves.
• The fs_more_test_harness_macros procedural macro crate has been removed in favor of the new fs_more_test_harness_generator CLI crate, which is part of the new test harness.

Full changes: v0.4.0...v0.5.0