io-addressbook 0.0.1

Set of I/O-free coroutines to manage contacts
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

# Contributing guide

Thank you for investing your time in contributing to addressbook Rust libraries!

## Development

The development environment is managed by [Nix](https://nixos.org/download.html).
Running `nix-shell` will spawn a shell with everything you need to get started with the lib.

If you do not want to use Nix, you can either use [rustup](https://rust-lang.github.io/rustup/index.html):

```text
rustup update
```

or install manually the following dependencies:

- [cargo](https://doc.rust-lang.org/cargo/)
- [rustc](https://doc.rust-lang.org/stable/rustc/platform-support.html)

## Build

```text
cargo build
```

You can disable default [features](https://doc.rust-lang.org/cargo/reference/features.html) with `--no-default-features` and enable features with `--features feat1,feat2,feat3`.

Finally, you can build a release with `--release`:

```text
cargo build --no-default-features --release
```

## Structure

The core library [`addressbook`](https://github.com/pimalaya/addressbook/tree/master/addressbook-lib) follows the [Sans I/O](https://sans-io.readthedocs.io/) pattern. It does not rely on any standard environment or async runtime. These are provided by external libraries called I/O connectors.

![sans-io](./sans-io.svg)

- A flow is a state machine defined as a Rust `Iterator` producing I/O request(s).
- The I/O connector is responsible for executing the requested I/O.
- The I/O connector communicates with the flow via its inner I/O state (take input, set output).
- A flow that does not produce any(more) I/O requests is considered terminated.
- A terminated flow exposes an `output()` function that takes the final output away from itself.

This repository comes with few I/O connectors:

- [`addressbook-carddav`](https://github.com/pimalaya/addressbook/tree/master/addressbook-carddav), a standard (blocking) CardDAV I/O connector
- [`addressbook-carddav-rustls`](https://github.com/pimalaya/addressbook/tree/master/addressbook-carddav-rustl), a standard (blocking) CardDAV I/O connector over TLS using [`rustls`](https://docs.rs/rustls/latest/rustls/)
- [`addressbook-carddav-native-tls`](https://github.com/pimalaya/addressbook/tree/master/addressbook-carddav-native-tls), a standard (blocking) CardDAV I/O connector over TLS using [`native-tls`](https://docs.rs/native-tls/latest/native_tls/)
- [`addressbook-vdir`](https://github.com/pimalaya/addressbook/tree/master/addressbook-vdir), a standard (blocking) [vdir](https://vdirsyncer.pimutils.org/en/stable/vdir.html) I/O connector

## Commit style

Addressbook libraries follow the [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/#summary).