fiffy 0.1.2

A Rust library intended for finding out everything about your beloved file system
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

# Fiffy [![Build Status](https://travis-ci.org/SeanPrashad/Fiffy.svg?branch=master)](https://travis-ci.org/SeanPrashad/Fiffy) [![Build Status]( https://img.shields.io/crates/v/fiffy.svg)](https://crates.io/crates/fiffy)

A Rust library designed to provide simple data for a given file path!

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Usage

1. `get_file_name(file_path: &str)` - returns the file name (as an `OsString`), given an absolute or relative path

  ```Rust
  let file_name = get_file_name("C:/Users/JohnDoe/Desktop/repos/Fiffy/README.md");
  println!("{:?}", file_name);  //prints "README.md"
  ```

2. `get_file_size(file_path: &str)` - returns the file size (as a `u64`), given an absolute or relative path

  ```Rust
  let file_size = get_file_size("C:/Users/JohnDoe/Desktop/repos/Fiffy/README.md");
  println!("{:?}", file_size);  //prints "82"
  ```

3. `generate_sha1(file_path: &str)` - returns the sha1 hash (as a `String`), given an absolute or relative path

  ```Rust
  let sha1_hash = generate_sha1("C:/Users/JohnDoe/Desktop/repos/Fiffy/README.md");
  println!("{:?}", sha1_hash);  //prints "e2ae20d9ae7fcacb605c03c198e0a1c51d446f50"
  ```

4. `generate_md5(file_path: &str)` - returns the md5 hash (as a `String`), given an absolute or relative path

  ```Rust
  let md5_hash = generate_md5("C:/Users/JohnDoe/Desktop/repos/Fiffy/README.md");
  println!("{:?}", md5_hash);  //prints "b958ee170050ed7a2f93509f13bf16c3"
  ```

### Installing Prerequisites

Below you'll find what's required to build and compile Fiffy:

#### Rust and Cargo

OSX/Unix installation (via [Terminal](https://en.wikipedia.org/wiki/Terminal_(macOS))):

```
curl -sSf https://static.rust-lang.org/rustup.sh | sh
```

Instructions for Microsoft Windows may be found **[here](https://github.com/rust-lang/cargo#compiling-from-source)**.

Further installation instructions can be found **[here](http://doc.crates.io/#installing)**.

### Building Fiffy

After installing the prerequisites listed above, you're ready to build!

1. First, clone the repository to your local machine via git:

  ```
  git clone https://github.com/SeanPrashad/Fiffy.git
  ```

  Or by downloading the `.zip` equivalent, found **[here](https://github.com/SeanPrashad/Fiffy/archive/master.zip)**.

  *Note*: Remember to extract the `.zip` file to a location where you conduct your work!

2. Next, `cd` into the downloaded repository using your Terminal (or Git Bash if on Windows):

  ```
  cd whereMyReposAreStored/Fiffy/
  ```

3. To build the source code, use:

  ```
  cargo build
  ```

*Note*: Supply the `--verbose` argument to get a more detailed output (ie. `cargo build --verbose`)

## Running the Test Suite

The test suite can be found within `src/lib.rs` in the module `tests`. To build and run all test suites, simply use:

```
cargo test
```

*Note*: Supply the `--verbose` argument to get a more detailed output (ie. `cargo test --verbose`)

## Linting

Rust comes with a built-in linter, Clippy, that's automatically configured to run when you build Fiffy.

To invoke Clippy on-demand, simply run:

```
cargo clippy
```

*Note*: Supply the `--verbose` argument to get a more detailed output (ie. `cargo clippy --verbose`). More information can be found **[here](https://github.com/rust-lang-nursery/rust-clippy#usage)**.


## Tools & Technologies

* [Rust](https://www.rust-lang.org/en-US/index.html) - A systems programming language
* [Crates.io](https://crates.io/) - Rust's Package Manager
* [Clippy](https://github.com/rust-lang-nursery/rust-clippy#rust-clippy) - Linting for Rust
* [Rust-Crypto](https://crates.io/crates/rust-crypto) - A library of common cryptographic algorithms

## Contributing

Any and all contributions are welcome, regardless of your programming expertise. Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to get started.

## Authors

* **Sean Prashad** - *Initial and on-going maintenance* - [@SeanPrashad](https://github.com/SeanPrashad)
* **David Humphrey** - *Documentation improvements/development suggestions* - [@humphd](https://github.com/humphd)
* **Marco Beltempo** - *Source code refinement* - [@marcobeltempo](https://github.com/marcobeltempo)

See also the list of [contributors](https://github.com/SeanPrashad/Fiffy/graphs/contributors) who participated in this project.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

## Acknowledgments

* #rust-beginners on Mozilla's IRC server for all of the help
* Professor David Humphrey for guiding, challenging and rewarding us with the world of Open Source