ron-crdt 0.4.0

Replicated Object Notation for 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
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
86
87
88
89
90
91

//! This is documentation for the `ron-crdt` crate.
//!
//! RON is the Replicated Object Notation, a distributed live data format
//! by [Victor Grishchenko](https://github.com/gritzko).
//!
//! RON is the language in which object states and mutations, as well
//! as all other parts of the Swarm protocol, are expressed in
//! Swarm. RON consists (solely!) of a series of UUIDs (128-bit
//! numbers), but the order of UUIDs matter, and there are many
//! different kinds of UUIDs, depending on the context.
//!
//! UUIDs provide sufficient metadata to object and their mutations to
//! allow the implementation of CRDTs in a network of peers.
//!
//! RON features two different wire formats: text and binary. Both
//! offer several ways of compression, adding to the complexity. We
//! will handle compression later, but note here that efficient
//! compression is what makes RON and Swarm practical. Compression
//! reduces the metadata overhead.
//!
//! One particular combination of four UUIDs makes up an operation
//! (short: ops) with one UUID each for the type, object, event and
//! value. Several operations make up the state or mutation of an
//! object, we call this a frame.
//!
//! Special kinds of RON ops are used for protocol handshakes and
//! frame headers (metadata for frames). These operations have special
//! meaning, and often omit some of the metadata that is usually
//! included in an operation (for example, a handshake query does not
//! have a timestamp).

#![warn(missing_docs)]

extern crate ron_uuid as uuid;
extern crate smallvec;
#[macro_use]
extern crate log;
#[cfg(test)]
extern crate simple_logger;

pub mod atom;
pub mod batch;
pub mod crdt;
pub mod frame;
pub mod heap;
pub mod op;

pub use uuid::UUID;

pub use crate::atom::Atom;
pub use crate::batch::Batch;
pub use crate::crdt::{Set, CRDT, LWW};
pub use crate::frame::Frame;
pub use crate::heap::{FrameOrd, Heap};
pub use crate::op::{Op, Terminator};

fn scan_for_integer<'a>(input: &'a str) -> Option<usize> {
    input.chars().position(|c| !c.is_ascii_digit() && c != '-' && c != '+')
}

fn scan_for_float<'a>(input: &'a str) -> Option<usize> {
    input.chars().position(|c| {
        !c.is_ascii_digit()
            && c != 'e'
            && c != 'E'
            && c != '.'
            && c != '-'
            && c != '+'
    })
}

fn scan_for_string<'a>(input: &'a str) -> Option<usize> {
    let mut escaped = false;
    for (off, ch) in input.char_indices() {
        escaped = match (ch, escaped) {
            ('\'', false) => return Some(off),
            ('\'', true) => false,

            ('\\', false) => true,
            ('\\', true) => false,

            ('n', true) => false,
            ('t', true) => false,

            (_, false) => false,
            (_, true) => false,
        };
    }

    None
}