fwalker

Crates.iofwalker
lib.rsfwalker
version0.4.1
sourcesrc
created_at2020-04-01 20:45:07.937086
updated_at2021-03-23 21:05:46.662579
descriptionLibrary for file and directory traversal in a file system
homepage
repositoryhttps://github.com/mantono/fwalker
max_upload_size
id225324
size25,844
Anton Österberg (mantono)

documentation

README

fwalker:walking:

A cargo crate for file and directory traversal in a file system through an iterator

Build & Test Security Audit License: MIT

Documentation

See docs.rs/fwalker for complete documentation and more advanced usage.

Usage

Add crate to Cargo.toml to use it

[dependencies]
fwalker = "0.3"

This crate has only one public struct, fwalker::Walker. With this struct, files and directories can be iterated over for any kind of listing, manipulation or processing. Creating a new walker can be done with either

  • fwalker::Walker::new() - starts from current directory
  • fwalker::Walker::from("/some/path") - starts from path /some/path

Quick example to get you started

use fwalker::Walker;
use std::path::PathBuf;

fn main() {
    Walker::from("/proc/sys")
        .expect("This *should* work")
        .take(10)
        .for_each(|file: PathBuf| println!("{:?}", file));
}

which would yield the output

"/proc/sys/abi/vsyscall32"
"/proc/sys/debug/exception-trace"
"/proc/sys/debug/kprobes-optimization"
"/proc/sys/fs/aio-max-nr"
"/proc/sys/fs/aio-nr"
"/proc/sys/fs/dentry-state"
"/proc/sys/fs/dir-notify-enable"
"/proc/sys/fs/file-max"
"/proc/sys/fs/file-nr"
"/proc/sys/fs/inode-nr"
Commit count: 104

cargo fmt