file_lookup 0.1.1

Simple functions to search up in the file tree for a file by name.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

# `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:

```rust
use file_lookup::home_find_file;

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

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

```rust
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:

```rust
pub enum FileLookupError {
    CwdNotFound,
    HomeDirNotFound,
};
```

## Installation

This crate is on [crates.io](https://crates.io/crates/file_lookup).

Install it with `cargo`:

```zsh
$ cargo add file_lookup
```