p2panda-sync 0.6.1

Local-first sync for append-only logs and traits to build your own
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

<h1 align="center">p2panda-sync</h1>

<div align="center">
  <img src="https://raw.githubusercontent.com/p2panda/.github/main/assets/panda-left.gif" width="auto" height="30px">
  <strong>Local-first sync for append-only logs and traits to build your own</strong>
  <img src="https://raw.githubusercontent.com/p2panda/.github/main/assets/panda-right.gif" width="auto" height="30px">
</div>

<div align="center">
  <h3>
    <a href="https://docs.rs/p2panda-sync">
      Documentation
    </a>
    <span> | </span>
    <a href="https://github.com/p2panda/p2panda/releases">
      Releases
    </a>
    <span> | </span>
    <a href="https://p2panda.org">
      Website
    </a>
  </h3>
</div>

Data-type agnostic interfaces for implementing sync protocols and managers which can be used
stand-alone or as part of the local-first stack provided by [`p2panda-net`].

Users can implement two-party sync protocols over a `Sink` / `Stream` pair with the `Protocol` trait
and a system for instantiating and orchestrating concurrent sync sessions with the `Manager` trait.

Concrete implementations for performing sync over p2panda append-only logs associated with a generic
topic can be found in the `manager` and `protocols` modules.

For most high-level users `p2panda-net` will be the entry point into local-first development with
p2panda. Interfaces in this crate are intended for cases where users want to integrate their own
base convergent data-type and sync protocols as a module in the `p2panda-net` stack.

> 🚧 This library is under active development and the APIs are not yet considered stable for
> production use. Core data types and user-facing APIs may still undergo breaking changes. Stability
> guarantees will improve with the release of v1.0.0.

[`p2panda-net`]: https://docs.rs/p2panda-net

## License

Licensed under either of [Apache License, Version 2.0] or [MIT license] at your option.

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

[Apache License, Version 2.0]: https://github.com/p2panda/p2panda/blob/main/LICENSES/Apache-2.0.txt
[MIT license]: https://github.com/p2panda/p2panda/blob/main/LICENSES/MIT.txt

---

_This project has received funding from the European Union’s Horizon 2020 research and innovation
programme within the framework of the NGI-POINTER Project funded under grant agreement No 871528,
NGI-ASSURE No 957073, NGI0-ENTRUST No 101069594 and NGI0-COMMONS No 101135429._