chore: fixes

Author: dnbln

.github/actions/test-dir-structure/action.yml

@@ -10,5 +10,5 @@ runs:
   using: "composite"
   steps:
     - name: Run tests
-      run: cargo test -p dir-structure ${{ inputs.feature-combos }} -- --test-threads=1
+      run: cargo test ${{ inputs.feature-combos }} --workspace -- --test-threads=1
       shell: bash

.github/workflows/test-dir-structure.yml

@@ -121,12 +121,12 @@ jobs:
       - name: Run feature-combo tests (--features assert_eq,include_dir)
         uses: ./.github/actions/test-dir-structure
         with: { feature-combos: "--features assert_eq,include_dir" }
-      - name: Run feature-combo tests (--no-default-features --features tools-atomic-dir)
+      - name: Run feature-combo tests (--no-default-features --features atomic-dir)
         uses: ./.github/actions/test-dir-structure
-        with: { feature-combos: "--no-default-features --features tools-atomic-dir" }
-      - name: Run feature-combo tests (--no-default-features --features tools-atomic-dir,async)
+        with: { feature-combos: "--no-default-features --features atomic-dir" }
+      - name: Run feature-combo tests (--no-default-features --features atomic-dir,async)
         uses: ./.github/actions/test-dir-structure
-        with: { feature-combos: "--no-default-features --features tools-atomic-dir,async" }
-      - name: Run feature-combo tests (--no-default-features --features tools-atomic-dir,async,tokio)
+        with: { feature-combos: "--no-default-features --features atomic-dir,async" }
+      - name: Run feature-combo tests (--no-default-features --features atomic-dir,async,tokio)
         uses: ./.github/actions/test-dir-structure
-        with: { feature-combos: "--no-default-features --features tools-atomic-dir,async,tokio" }
+        with: { feature-combos: "--no-default-features --features atomic-dir,async,tokio" }

dir-structure-tools/Cargo.toml

@@ -158,16 +158,6 @@ name = "writing_to_tokio_fs_vfs"
 path = "examples/writing_to_tokio_fs_vfs.rs"
 required-features = ["tokio", "async", "derive"]
 
-[[example]]
-name = "resolve_path"
-path = "examples/resolve_path.rs"
-required-features = ["resolve-path", "derive"]
-
-[[example]]
-name = "load_path"
-path = "examples/load_path.rs"
-required-features = ["resolve-path", "derive"]
-
 [[example]]
 name = "std_fs_vfs"
 path = "examples/std_fs_vfs.rs"

dir-structure-tools/examples/README.md

@@ -0,0 +1,39 @@
+# `dir-structure-tools` examples
+
+A collection of examples demonstrating various tools in the `dir-structure-tools` crate.
+
+## `CleanDir`
+
+- [clean_dir.rs](clean_dir.rs): An example demonstrating the use of `CleanDir` to ensure a directory is clean before writing.
+
+## `data_formats::*`
+
+- [json.rs](json.rs): An example demonstrating the use of `Json` to read and write JSON files.
+- [json_pretty.rs](json_pretty.rs): An example demonstrating the use of `JsonPretty` to read and write pretty-printed JSON files.
+- [toml.rs](toml.rs): An example demonstrating the use of `Toml` to read and write TOML files.
+- [yaml.rs](yaml.rs): An example demonstrating the use of `Yaml` to read and write YAML files.
+- [ron.rs](ron.rs): An example demonstrating the use of `Ron` to read and write RON files.
+- [ron_pretty.rs](ron_pretty.rs): An example demonstrating the use of `RonPretty` to read and write pretty-printed RON files.
+
+## A note on the following examples
+
+The examples above demonstrate the basic usage of the `dir-structure` crate with the default synchronous VFS (`StdFsVfs`). While
+98% of use-cases can be covered with just those basic usage patterns, the crate also supports more advanced features, which are
+demonstrated in the examples below.
+
+> [!IMPORTANT]
+> A warning first: In order to understand the examples below, it is recommended to read the documentation for the
+> [`dir_structure::traits::vfs` module](../../dir-structure/src/traits/vfs.rs) first.
+
+## `DeferredRead`
+
+- [deferred_read.rs](deferred_read.rs): An example demonstrating the use of `DeferredRead` to defer reading file contents until they are needed.
+
+## `DeferredReadOrOwn`
+
+- [deferred_read_or_own.rs](deferred_read_or_own.rs): An example demonstrating the use of `DeferredReadOrOwn` to defer reading file contents and cache them.
+
+## `DirChildren`
+
+- [reading_dir_children.rs](reading_dir_children.rs): An example demonstrating the use of `DirChildren` to read dynamic directory contents.
+- [writing_dir_children.rs](writing_dir_children.rs): An example demonstrating the use of `DirChildren` to write dynamic directory contents.

dir-structure/Cargo.toml

@@ -138,3 +138,23 @@ git2 = { workspace = true, optional = true }
 
 [lints]
 workspace = true
+
+[[example]]
+name = "reading_from_tokio_fs_vfs"
+path = "examples/reading_from_tokio_fs_vfs.rs"
+required-features = ["tokio", "async", "derive"]
+
+[[example]]
+name = "writing_to_tokio_fs_vfs"
+path = "examples/writing_to_tokio_fs_vfs.rs"
+required-features = ["tokio", "async", "derive"]
+
+[[example]]
+name = "resolve_path"
+path = "examples/resolve_path.rs"
+required-features = ["resolve-path", "derive"]
+
+[[example]]
+name = "load_path"
+path = "examples/load_path.rs"
+required-features = ["resolve-path", "derive"]

dir-structure/README.md

@@ -0,0 +1 @@
+../README.md

dir-structure/examples/README.md

@@ -7,18 +7,17 @@ A collection of examples demonstrating various features of the `dir-structure` c
 - [reading.rs](reading.rs): A simple example of reading a directory structure from disk.
 - [writing.rs](writing.rs): A simple example of writing a directory structure to disk.
 
-## `CleanDir`
+## `resolve_path`
+
+- [resolve_path.rs](resolve_path.rs): An example demonstrating the use of `resolve_path` to resolve paths within a directory structure.
+
+## `load_path`
 
-- [clean_dir.rs](clean_dir.rs): An example demonstrating the use of `CleanDir` to ensure a directory is clean before writing.
+- [load_path.rs](load_path.rs): An example demonstrating the use of `load_path` to load a specific file from a path within a directory structure, without loading the entire structure.
 
-## `data_formats::*`
+## `dir-structure-tools`
 
-- [json.rs](json.rs): An example demonstrating the use of `Json` to read and write JSON files.
-- [json_pretty.rs](json_pretty.rs): An example demonstrating the use of `JsonPretty` to read and write pretty-printed JSON files.
-- [toml.rs](toml.rs): An example demonstrating the use of `Toml` to read and write TOML files.
-- [yaml.rs](yaml.rs): An example demonstrating the use of `Yaml` to read and write YAML files.
-- [ron.rs](ron.rs): An example demonstrating the use of `Ron` to read and write RON files.
-- [ron_pretty.rs](ron_pretty.rs): An example demonstrating the use of `RonPretty` to read and write pretty-printed RON files.
+Also see [the examples in the `dir-structure-tools` crate](../../dir-structure-tools/examples/), which demonstrate more advanced features of the `dir-structure` crate.
 
 ## A note on the following examples
 
@@ -30,19 +29,6 @@ demonstrated in the examples below.
 > A warning first: In order to understand the examples below, it is recommended to read the documentation for the
 > [`dir_structure::traits::vfs` module](../src/traits/vfs.rs) first.
 
-## `DeferredRead`
-
-- [deferred_read.rs](deferred_read.rs): An example demonstrating the use of `DeferredRead` to defer reading file contents until they are needed.
-
-## `DeferredReadOrOwn`
-
-- [deferred_read_or_own.rs](deferred_read_or_own.rs): An example demonstrating the use of `DeferredReadOrOwn` to defer reading file contents and cache them.
-
-## `DirChildren`
-
-- [reading_dir_children.rs](reading_dir_children.rs): An example demonstrating the use of `DirChildren` to read dynamic directory contents.
-- [writing_dir_children.rs](writing_dir_children.rs): An example demonstrating the use of `DirChildren` to write dynamic directory contents.
-
 ## Virtual File Systems (VFS)
 
 ### Library-provided synchronous VFS implementations
@@ -51,7 +37,7 @@ demonstrated in the examples below.
 
 - [std_fs_vfs.rs](std_fs_vfs.rs): An example of reading / writing a directory structure from the actual file system using the `StdFsVfs`. Note that this is the default VFS used by `DirStructureItem::read` and `DirStructureItem::write`, so all the examples listed above use this VFS implicitly. This example is just to demonstrate the explicit use of the `StdFsVfs`.
 
-#### `include_dir` VFS
+<!-- #### `include_dir` VFS
 
 - [reading_from_include_dir_vfs.rs](reading_from_include_dir_vfs.rs): An example of reading a directory structure from an embedded file system using the `include_dir_vfs!` macro.
 - [reading_dir_children_from_include_dir_vfs.rs](reading_dir_children_from_include_dir_vfs.rs): An example demonstrating the use of `DirChildren` to read dynamic directory contents from an embedded file system using the `include_dir_vfs!` macro.
@@ -62,7 +48,7 @@ Note that the `include_dir` VFS is read-only, so there are no writing examples.
 
 - [reading_from_git_vfs.rs](reading_from_git_vfs.rs): An example of reading a directory structure from a git repository.
 
-Note that the `git` VFS is read-only, so there are no writing examples.
+Note that the `git` VFS is read-only, so there are no writing examples. -->
 
 ### Library-provided asynchronous VFS implementations
 
@@ -71,11 +57,3 @@ Note that the `git` VFS is read-only, so there are no writing examples.
 - [reading_from_tokio_fs_vfs.rs](reading_from_tokio_fs_vfs.rs): An example of reading a directory structure from the actual file system using `TokioFsVfs`.
 - [writing_to_tokio_fs_vfs.rs](writing_to_tokio_fs_vfs.rs): An example of writing a directory structure to the actual file system using `TokioFsVfs`.
 
-
-## `resolve_path`
-
-- [resolve_path.rs](resolve_path.rs): An example demonstrating the use of `resolve_path` to resolve paths within a directory structure.
-
-## `load_path`
-
-- [load_path.rs](load_path.rs): An example demonstrating the use of `load_path` to load a specific file from a path within a directory structure, without loading the entire structure.