Available on crate feature
listing only.Expand description
Directory listing and recursive traversal.
Enabled by the listing feature (default).
§Depth model
Depth is measured the same way as walkdir and
crate::discovery::DiscoveryOptions:
- Depth 0 — the walk root itself
- Depth 1 — immediate children of the root
- Depth n — n path components below the root
recursive | max_depth | Effect |
|---|---|---|
false | ignored | Only immediate children (depth 1). Optionally include root via include_root. |
true | None | Unlimited depth |
true | Some(n) | Walkdir max_depth = n (root is depth 0) |
Prefer list when you need sorted results. Prefer walk for streaming
(unsorted walk order).
Structs§
- List
Options - Options controlling directory listing and traversal.
- Walk
Iter - Streaming iterator produced by
walk.
Functions§
- list
- List filesystem entries under
rootaccording tooptions. - list_
async async - Async wrapper around
listusingspawn_blocking. - walk
- Stream filesystem entries under
rootin walk order.