file_lookup

Crates.iofile_lookup
lib.rsfile_lookup
version0.2.2
sourcesrc
created_at2023-04-22 00:29:13.495629
updated_at2023-10-17 00:28:16.45093
descriptionSimple functions to search up in the file tree for a file by name.
homepage
repository
max_upload_size
id845758
size5,516
Ben Shaver (bpshaver)

documentation

README

file_lookup

For when you want to look up from the current working directory for a file by name.

Example Usage

Find a file within your home directory, looking up from your current working directory:

use file_lookup::home_find_file;

let path = home_find_file("some_file.json").unwrap();

Find a file within your root directory (or anywhere else), looking up from your current working directory:

use std::path::PathBuf;
use file_lookup::find_file;

let path = find_file("some_file.json", &PathBuf::from("/")).unwrap();

Errors

These functions fail if there is a failure to ascertain your current working directory or your home directory:

pub enum FileLookupError {
    CwdNotFound,
    HomeDirNotFound,
};

Installation

This crate is on crates.io.

Install it with cargo:

$ cargo add file_lookup
Commit count: 0

cargo fmt