autosurgeon 0.3.2

A library for working with data in automerge documents
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
75
76
77
78
79
80
81
82
83
84
85

# `autosurgeon`

[![Build](https://github.com/alexjg/autosurgeon/actions/workflows/ci.yaml/badge.svg)](https://github.com/alexjg/autosurgeon/actions/workflows/ci.yaml)
[![crates](https://img.shields.io/crates/v/autosurgeon)](https://crates.io/crates/autosurgeon)
[![docs](https://img.shields.io/docsrs/autosurgeon?color=blue)](https://docs.rs/autosurgeon/latest/autosurgeon/)

Autosurgeon is a Rust library for working with data in
[automerge](https://automerge.org/) documents. See the [documentation](https://docs.rs/autosurgeon/latest/autosurgeon/) for a detailed guide.


## Quickstart

`autosurgeon` requires rust `1.65` or newer.

Add `autosurgeon` to your dependencies with `cargo add`

```shell
cargo add autosurgeon
```

Then we can define a data model which derives `Reconcile` and `Hydrate` and
start reading and writing from automerge documents

```rust
use autosurgeon::{Reconcile, Hydrate, hydrate, reconcile};

// A simple contact document

#[derive(Debug, Clone, Reconcile, Hydrate, PartialEq)]
struct Contact {
    name: String,
    address: Address,
}

#[derive(Debug, Clone, Reconcile, Hydrate, PartialEq)]
struct Address {
   line_one: String,
   line_two: Option<String>,
   city: String,
   postcode: String,
}

let mut contact = Contact {
     name: "Sherlock Holmes".to_string(),
     address: Address{
         line_one: "221B Baker St".to_string(),
         line_two: None,
         city: "London".to_string(),
         postcode: "NW1 6XE".to_string(),
     },
};

// Put data into a document
let mut doc = automerge::AutoCommit::new();
reconcile(&mut doc, &contact).unwrap();

// Get data out of a document
let contact2: Contact = hydrate(&doc).unwrap();
assert_eq!(contact, contact2);

// Fork and make changes
let mut doc2 = doc.fork().with_actor(automerge::ActorId::random());
let mut contact2: Contact = hydrate(&doc2).unwrap();
contact2.name = "Dangermouse".to_string();
reconcile(&mut doc2, &contact2).unwrap();

// Concurrently on doc1
contact.address.line_one = "221C Baker St".to_string();
reconcile(&mut doc, &contact).unwrap();

// Now merge the documents
// Reconciled changes will merge in somewhat sensible ways
doc.merge(&mut doc2).unwrap();

let merged: Contact = hydrate(&doc).unwrap();
assert_eq!(merged, Contact {
    name: "Dangermouse".to_string(), // This was updated in the first doc
    address: Address {
          line_one: "221C Baker St".to_string(), // This was concurrently updated in doc2
          line_two: None,
          city: "London".to_string(),
          postcode: "NW1 6XE".to_string(),
    }
})
```