lz-str 0.1.0

A port of lz-string to Rust
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

# lz-str-rs

![Rust](https://github.com/adumbidiot/lz-str-rs/workflows/Rust/badge.svg)

A port of [lz-string](https://github.com/pieroxy/lz-string) to Rust. 

### Installing


Add the following to your `Cargo.toml` file:

```toml
[dependencies]
lz-str = { git = "https://github.com/adumbidiot/lz-str-rs" }
```

## Getting Started


```rust
use lz_str::{
    compress_str,
    decompress_str,
};

const DATA_STR: &'static str = "The quick brown fox jumps over the lazy dog";

fn main(){
    let compressed = compress_str(&DATA_STR);
    let decompressed = decompress_str(&compressed).unwrap();
    assert_eq!(DATA_STR, decompressed);
}
```


## Testing

```bash
cargo test
```

## Benching

```bash
cargo bench
```

## Authors

adumbidiot (Nathaniel Daniel)

## License

Licensed under either of
 * Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contributing

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.