# quirks
Miscellaneous helper functions for your library or application.
## Installation
Simply run the following inside your Rust project:
```sh
cargo add quirks
```
## Usage
Include the quirk(s) you want to use:
```rust
use std::fs;
use anyhow::Result;
use quirks::Edible;
fn main() -> Result<()> {
let contents = fs::read_to_string("a_file_with_a_newline_at_the_end.txt")?.chomp();
println!("{}", contents); // No double-newline
Ok(())
}
```
# Quirks
Below is a list of all the quirks and what they do. For more details,
run `cargo doc --open` and browse the `quirks` crate.
- Edible: Remove trailing newlines from &[str]s or [String]s via the
`chomp()` function.
- Lazy: Provides the `nop!()` macro, which does nothing (no operation).
- Odyssey: Expand paths with a '~' (tilde) from &[str]s, [String]s, or
[PathBuf]s via the `expand()` function.
# Building
```sh
git clone https://library.cat/rory/quirks
cd quirks
cargo build
```