Struct dowser::Dowser

source ·

pub struct Dowser { /* private fields */ }

Expand description

§Dowser.

Dowser is a very simple recursive file iterator. Symlinks and hidden nodes are followed like any other, and all results are canonicalized and deduped prior to yielding.

§Usage

All you need to do is chain Dowser::default with one or more of the following seed methods:

The with_* methods add sources to be crawled, while the without_* methods shitlist sources, preventing them from being yielded by the iterator.

If using without_*, be sure to chain those first, before any with_* calls, just in case your withs and withouts overlap. ;)

From there, you can do your normal Iterator business, or if you just want to collect the results into a vector, call Dowser::into_vec or Dowser::into_vec_filtered.

§Examples

use dowser::Dowser;
use std::path::PathBuf;

let files: Vec<PathBuf> = Dowser::default()
    .with_path("/usr/share")
    // You could filter_map(), etc., here, with the understanding that
    // every path you get will belong to a valid, canonical file.
    .collect();

Implementations§

source §

impl Dowser

source

pub fn with_path(self, path: P) -> Self
where P: AsRef<Path>,

§With Path.

Queue up a single file or directory path.

This can be called multiple times, but Dowser::with_paths probably makes more sense when you want to crawl multiple roots.

§Examples

use dowser::Dowser;
use std::path::PathBuf;

let files: Vec::<PathBuf> = Dowser::default()
    .with_path("/my/dir")
    .collect();

source

pub fn with_paths<P, I>(self, paths: I) -> Self
where P: AsRef<Path>, I: IntoIterator<Item = P>,

§With Paths.

Queue up multiple file and/or directory paths.

§Examples

use dowser::Dowser;
use std::path::PathBuf;

let files: Vec::<PathBuf> = Dowser::default()
    .with_paths(&["/my/dir"])
    .collect();

§Panics

This will panic if you try to pass a single Path or PathBuf object directly to this method (instead of a collection of same). Use Dowser::with_path to add such an object directly.

source §

impl Dowser

source

pub fn without_path(self, path: P) -> Self
where P: AsRef<Path>,

§Without Path.

This will prevent the provided directory or file from being crawled or included in the output.

Note: without-path(s) should be specified before with-path(s), just in case the sets overlap.

§Examples

use dowser::Dowser;
use std::path::PathBuf;

let files: Vec<PathBuf> = Dowser::default()
    .without_path("/my/dir/ignore")
    .with_path("/my/dir")
    .collect();

source

pub fn without_paths<P, I>(self, paths: I) -> Self
where P: AsRef<Path>, I: IntoIterator<Item = P>,

§Without Paths.

This will prevent the provided directories or files from being crawled or included in the output.

Note: without-path(s) should be specified before with-path(s), just in case the sets overlap.

§Examples

use dowser::Dowser;
use std::path::PathBuf;

let files: Vec<PathBuf> = Dowser::default()
    .without_paths(&["/my/dir/ignore"])
    .with_path("/my/dir")
    .collect();

§Panics

This will panic if you try to pass a single Path or PathBuf object directly to this method (instead of a collection of same). Use Dowser::without_path to add such an object directly.

source §

impl Dowser

source

pub fn into_vec(self) -> Vec<PathBuf>

§Consume Into Vec.

This method is an optimized alternative to running Dowser.iter().collect::<Vec<PathBuf>>().

It yields the same results as the above, but makes fewer allocations along the way.

§Examples

use dowser::Dowser;
use std::path::PathBuf;

// The iterator way.
let files: Vec<PathBuf> = Dowser::default()
    .with_path("/usr/share")
    .collect();

// The optimized way.
let files: Vec<PathBuf> = Dowser::default()
    .with_path("/usr/share")
    .into_vec();

source

pub fn into_vec_filtered<F>(self, cb: F) -> Vec<PathBuf>
where F: Fn(&Path) -> bool + Sync + Send,

§Consume Into Vec (Filtered).

This method is an optimized alternative to running Dowser.iter().filter(…).collect::<Vec<PathBuf>>().

It yields the same results as the above, but makes fewer allocations along the way.

Note: every entry passed to your callback will be a valid, canonical file path. (You don’t have to explicitly test for is_file or anything like that.)

§Examples

use dowser::Dowser;
use std::path::PathBuf;

// The iterator way.
let files: Vec<PathBuf> = Dowser::default()
    .with_path("/usr/share")
    .filter(|p|
        p.extension().map_or(
            false,
            |e| e.eq_ignore_ascii_case("jpg")
        )
    )
    .collect();

// The optimized way.
let files: Vec<PathBuf> = Dowser::default()
    .with_path("/usr/share")
    .into_vec_filtered(|p|
        p.extension().map_or(
            false,
            |e| e.eq_ignore_ascii_case("jpg")
        )
    );

Trait Implementations§

source §

impl Clone for Dowser

source §

fn clone(&self) -> Dowser ⓘ

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source §

impl Debug for Dowser

source §

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source §

impl Default for Dowser

source §

fn default() -> Self

Returns the “default value” for a type. Read more

source §