dir-structure 0.3.0

Model directory structures as plain Rust structs.
Documentation
Build #2585774 2025-10-14 14:34:22

# rustc version rustc 1.92.0-nightly (4b94758d2 2025-10-13)

# docs.rs version docsrs 0.6.0 (f42173de 2025-09-12)

# build log [INFO] running `Command { std: "docker" "create" "-v" "/home/cratesfyi/workspace-builder/builds/dir-structure-0.3.0/target:/opt/rustwide/target:rw,Z" "-v" "/home/cratesfyi/workspace-builder/builds/dir-structure-0.3.0/source:/opt/rustwide/workdir:ro,Z" "-v" "/home/cratesfyi/workspace-builder/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/home/cratesfyi/workspace-builder/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "DOCS_RS=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "6442450944" "--cpus" "6" "--user" "1001:1001" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:e90291280db7d1fac5b66fc6dad9f9662629e7365a55743daf9bdf73ebc4ea79" "/opt/rustwide/cargo-home/bin/cargo" "+nightly" "rustdoc" "--lib" "-Zrustdoc-map" "--all-features" "--config" "build.rustdocflags=[\"--cfg\", \"docsrs\", \"--cfg\", \"docsrs\", \"-Z\", \"unstable-options\", \"--emit=invocation-specific\", \"--resource-suffix\", \"-20251013-1.92.0-nightly-4b94758d2\", \"--static-root-path\", \"/-/rustdoc.static/\", \"--cap-lints\", \"warn\", \"--extern-html-root-takes-precedence\"]" "--offline" "-Zunstable-options" "--config=doc.extern-map.registries.crates-io=\"https://docs.rs/{pkg_name}/{version}/x86_64-unknown-linux-gnu\"" "-Zrustdoc-scrape-examples" "-j6" "--target" "x86_64-unknown-linux-gnu", kill_on_drop: false }` [INFO] [stderr] WARNING: Your kernel does not support swap limit capabilities or the cgroup is not mounted. Memory limited without swap. [INFO] [stdout] bc9a811749a4cfa210cfcc56c71c230b1157d1855a057280bc055fb3c9edd0aa [INFO] running `Command { std: "docker" "start" "-a" "bc9a811749a4cfa210cfcc56c71c230b1157d1855a057280bc055fb3c9edd0aa", kill_on_drop: false }` [INFO] [stderr] warning: Rustdoc did not scrape the following examples because they require dev-dependencies: load_path, reading, reading_from_tokio_fs_vfs, resolve_path, std_fs_vfs, writing, writing_to_tokio_fs_vfs [INFO] [stderr] If you want Rustdoc to scrape these examples, then add `doc-scrape-examples = true` [INFO] [stderr] to the [[example]] target configuration of at least one example. [INFO] [stderr] warning: target filter specified, but no targets matched; this is a no-op [INFO] [stderr] Documenting dir-structure v0.3.0 (/opt/rustwide/workdir) [INFO] [stderr] warning: unresolved link to `crate::deferred_read::DeferredRead` [INFO] [stderr] --> src/traits/vfs.rs:28:22 [INFO] [stderr] | [INFO] [stderr] 28 | //! [`DeferredRead`][crate::deferred_read::DeferredRead], which will hold a reference [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `deferred_read` in module `dir_structure` [INFO] [stderr] | [INFO] [stderr] = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::deferred_read::DeferredRead` [INFO] [stderr] --> src/traits/vfs.rs:32:55 [INFO] [stderr] | [INFO] [stderr] 32 | //! [`WriteTo`] implementations with [`DeferredRead`][crate::deferred_read::DeferredRead] [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `deferred_read` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::atomic_dir::AtomicDir` [INFO] [stderr] --> src/traits/vfs.rs:91:86 [INFO] [stderr] | [INFO] [stderr] 91 | //! extra functionality that is required by the tool. For example, the [`AtomicDir`](crate::atomic_dir::AtomicDir) [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `atomic_dir` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::atomic_dir::AtomicDir` [INFO] [stderr] --> src/traits/vfs.rs:99:26 [INFO] [stderr] | [INFO] [stderr] 99 | //! ### [`AtomicDir<T>`](crate::atomic_dir::AtomicDir) [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `atomic_dir` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::atomic_dir::AtomicDir` [INFO] [stderr] --> src/traits/vfs.rs:101:27 [INFO] [stderr] | [INFO] [stderr] 101 | //! For the [`AtomicDir`](crate::atomic_dir::AtomicDir) tool to work, the VFS type itself must implement [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `atomic_dir` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::atomic_dir::VfsSupportsTemporaryDirectories` [INFO] [stderr] --> src/traits/vfs.rs:102:45 [INFO] [stderr] | [INFO] [stderr] 102 | //! the [`VfsSupportsTemporaryDirectories`](crate::atomic_dir::VfsSupportsTemporaryDirectories) trait. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `atomic_dir` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::deferred_read::DeferredRead` [INFO] [stderr] --> src/traits/vfs.rs:201:71 [INFO] [stderr] | [INFO] [stderr] 201 | /// a reference to the `Vfs` instance (e.g., via [`DeferredRead`][crate::deferred_read::DeferredRead]). [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `deferred_read` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::dir_descendants::DirDescendants` [INFO] [stderr] --> src/traits/vfs.rs:568:58 [INFO] [stderr] | [INFO] [stderr] 568 | /// This is needed when reading a [`DirDescendants`][crate::dir_descendants::DirDescendants], [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `dir_descendants` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::atomic_dir::AtomicDir` [INFO] [stderr] --> src/traits/async_vfs.rs:29:25 [INFO] [stderr] | [INFO] [stderr] 29 | //! ## [`AtomicDir<T>`](crate::atomic_dir::AtomicDir) [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `atomic_dir` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::atomic_dir::AtomicDir` [INFO] [stderr] --> src/traits/async_vfs.rs:31:33 [INFO] [stderr] | [INFO] [stderr] 31 | //! To use the [`AtomicDir<T>`](crate::atomic_dir::AtomicDir) wrapper type with your async VFS implementation, [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `atomic_dir` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::atomic_dir::VfsSupportsTemporaryDirectories` [INFO] [stderr] --> src/traits/async_vfs.rs:32:80 [INFO] [stderr] | [INFO] [stderr] 32 | //! the VFS type itself must implement the [`VfsSupportsTemporaryDirectories`](crate::atomic_dir::VfsSupportsTemporaryDirectories) trait. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `atomic_dir` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::image` [INFO] [stderr] --> src/traits/async_vfs.rs:35:17 [INFO] [stderr] | [INFO] [stderr] 35 | //! ## [Images](crate::image) [INFO] [stderr] | ^^^^^^^^^^^^ no item named `image` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::image` [INFO] [stderr] --> src/traits/async_vfs.rs:38:15 [INFO] [stderr] | [INFO] [stderr] 38 | //! [`image`](crate::image) module, the following traits need to be implemented for your [INFO] [stderr] | ^^^^^^^^^^^^ no item named `image` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `tokio::task::spawn_blocking` [INFO] [stderr] --> src/traits/async_vfs.rs:50:7 [INFO] [stderr] | [INFO] [stderr] 50 | //! [`tokio::task::spawn_blocking`] to offload the blocking operations to a separate thread pool. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `spawn_blocking` in module `task` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::dir_children::DirChildren` [INFO] [stderr] --> src/traits/resolve.rs:51:29 [INFO] [stderr] | [INFO] [stderr] 51 | /// such as [`DirChildren`](crate::dir_children::DirChildren), [`DirDescendants`](crate::dir_descendants::DirDescendants), etc. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `dir_children` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: unresolved link to `crate::dir_descendants::DirDescendants` [INFO] [stderr] --> src/traits/resolve.rs:51:83 [INFO] [stderr] | [INFO] [stderr] 51 | /// such as [`DirChildren`](crate::dir_children::DirChildren), [`DirDescendants`](crate::dir_descendants::DirDescendants), etc. [INFO] [stderr] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ no item named `dir_descendants` in module `dir_structure` [INFO] [stderr] [INFO] [stderr] warning: `dir-structure` (lib doc) generated 16 warnings [INFO] [stderr] Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.69s [INFO] [stderr] Generated /opt/rustwide/target/x86_64-unknown-linux-gnu/doc/dir_structure/index.html [INFO] running `Command { std: "docker" "inspect" "bc9a811749a4cfa210cfcc56c71c230b1157d1855a057280bc055fb3c9edd0aa", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "bc9a811749a4cfa210cfcc56c71c230b1157d1855a057280bc055fb3c9edd0aa", kill_on_drop: false }` [INFO] [stdout] bc9a811749a4cfa210cfcc56c71c230b1157d1855a057280bc055fb3c9edd0aa