rskey 0.1.1

rskey is a simple key-value store of strings, with a basic CLI tool to list, get, and set key-value pairs.
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

[![Workflow Status](https://github.com/bitfield/rskey/workflows/CI/badge.svg)](https://github.com/bitfield/rskey/actions?query=workflow%3A%22CI%22)
![Maintenance](https://img.shields.io/badge/maintenance-activly--developed-brightgreen.svg)

# rskey

A simple key-value store of strings.

### Getting started

```rust
use rskey::Store;
use tempfile::TempDir;

let tmp_dir = TempDir::new()?;
let mut s = Store::open_or_create(tmp_dir.path().join("data.kv"))?;
s.set("key1", "value1")?;
assert_eq!("value1", s.get("key1").unwrap());
```

### Iteration

```rust
use rskey::Store;
use tempfile::TempDir;

let tmp_dir = TempDir::new()?;
let mut s = Store::open_or_create(tmp_dir.path().join("data.kv"))?;
s.set("key1", "value1")?;
s.set("key2", "value2")?;
for (key, value) in s {
    println!("{key} = ${value}");
}
```

A basic CLI tool is also included to list, get, and set key-value pairs.

### Installation

```sh
cargo install rskey
```

### Usage

`rskey` expects to find a data file named `store.kv` in the current
directory. If there is no such file, one will be created as soon as you set
a key.

#### Listing all data

```sh
rskey list
```
```
key1: value1
key2: value2
```

#### Getting a value by key

```sh
rskey get key1
```
```
key1: value1
```

#### Setting a key-value pair

```sh
rskey set key3 value3
```

License: MIT OR Apache-2.0