kankyo 0.3.0

Simple, efficient, and precise .env library.
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

[![ci-badge][]][ci] [![license-badge][]][license] [![docs-badge][]][docs] [![rust badge]][rust link]

`kankyo` is a crate for the loading and unloading of `.env` files or other
readers into and from the environment.

This crate is meant to be a more modular and efficient, yet concise
collection of functions exposed for any custom requirement. Due to its
design, it is applicable in both synchronous and asynchronous applications.

### Installation

This library requires at least Rust 1.0.0.

Add the following dependency to your project's `Cargo.toml`:

```toml
kankyo = "0.3"
```

### What are `.env` files?

Environment variable files, often named `.env`, are files usually located at
the project root. The contents of the file are `=` (equals sign)-delimited
lines of key-value pairs. A sample file might look like:

```ini
DEBUG=info
DB_HOST=127.0.0.1 # This is a comment, not parsed as part of the value.

# Empty lines are ignored, as are lines solely consisting of a comment.
```

### Usage

The library works with interfacing over readers (types implementing the
`std::io::Read` trait), meaning that you can pass slices of bytes, strings,
files, etc. to it.

For example, opening a file and parsing its contents into the environment:

```rust,no_run
extern crate kankyo;

use std::fs::File;

kankyo::load_from_reader(File::open("./.env")?)?;

println!("Loaded!");
```

Due to the common nature of this operation, a function that does precisely
this is offered:

```rust,no_run
extern crate kankyo;

kankyo::load()?;

println!("Loaded!");
```

### License

License info in [LICENSE.md]. Long story short, ISC.

[LICENSE.md]: https://github.com/rusty-crates/kankyo/blob/master/LICENSE.md
[ci]: https://travis-ci.org/rusty-crates/kankyo
[ci-badge]: https://img.shields.io/travis/rusty-crates/kankyo.svg?style=flat-square
[docs]: https://docs.rs/kankyo
[docs-badge]: https://img.shields.io/badge/docs-online-5023dd.svg?style=flat-square
[license]: https://opensource.org/licenses/ISC
[license-badge]: https://img.shields.io/badge/license-ISC-blue.svg?style=flat-square
[rust badge]: https://img.shields.io/badge/rust-1.0+-93450a.svg?style=flat-square
[rust link]: https://blog.rust-lang.org/2015/05/15/Rust-1.0.html