y-octo 0.0.3

High-performance and thread-safe CRDT implementation compatible with Yjs
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

use std::sync::atomic::{AtomicU8, Ordering};

#[rustfmt::skip]
#[allow(dead_code)]
pub mod item_flags {
    pub const ITEM_KEEP                 : u8 = 0b0000_0001;
    pub const ITEM_COUNTABLE            : u8 = 0b0000_0010;
    pub const ITEM_DELETED              : u8 = 0b0000_0100;
    pub const ITEM_MARKED               : u8 = 0b0000_1000;
    pub const ITEM_HAS_PARENT_SUB       : u8 = 0b0010_0000;
    pub const ITEM_HAS_RIGHT_ID         : u8 = 0b0100_0000;
    pub const ITEM_HAS_LEFT_ID          : u8 = 0b1000_0000;
    pub const ITEM_HAS_SIBLING          : u8 = 0b1100_0000;
}

#[derive(Debug)]
pub struct ItemFlag(pub(self) AtomicU8);

impl Default for ItemFlag {
    fn default() -> Self {
        Self(AtomicU8::new(0))
    }
}

impl Clone for ItemFlag {
    fn clone(&self) -> Self {
        Self(AtomicU8::new(self.0.load(Ordering::Acquire)))
    }
}

impl From<u8> for ItemFlag {
    fn from(flags: u8) -> Self {
        Self(AtomicU8::new(flags))
    }
}

#[allow(dead_code)]
impl ItemFlag {
    #[inline(always)]
    pub fn set(&self, flag: u8) {
        self.0.fetch_or(flag, Ordering::SeqCst);
    }

    #[inline(always)]
    pub fn clear(&self, flag: u8) {
        self.0.fetch_and(!flag, Ordering::SeqCst);
    }

    #[inline(always)]
    pub fn check(&self, flag: u8) -> bool {
        self.0.load(Ordering::Acquire) & flag == flag
    }

    #[inline(always)]
    pub fn not(&self, flag: u8) -> bool {
        self.0.load(Ordering::Acquire) & flag == 0
    }

    #[inline(always)]
    pub fn keep(&self) -> bool {
        self.check(item_flags::ITEM_KEEP)
    }

    #[inline(always)]
    pub fn set_keep(&self) {
        self.set(item_flags::ITEM_KEEP);
    }

    #[inline(always)]
    pub fn clear_keep(&self) {
        self.clear(item_flags::ITEM_KEEP);
    }

    #[inline(always)]
    pub fn countable(&self) -> bool {
        self.check(item_flags::ITEM_COUNTABLE)
    }

    #[inline(always)]
    pub fn set_countable(&self) {
        self.set(item_flags::ITEM_COUNTABLE);
    }

    #[inline(always)]
    pub fn clear_countable(&self) {
        self.clear(item_flags::ITEM_COUNTABLE);
    }

    #[inline(always)]
    pub fn deleted(&self) -> bool {
        self.check(item_flags::ITEM_DELETED)
    }

    #[inline(always)]
    pub fn set_deleted(&self) {
        self.set(item_flags::ITEM_DELETED);
    }

    #[inline(always)]
    pub fn clear_deleted(&self) {
        self.clear(item_flags::ITEM_DELETED);
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_flag_set_and_clear() {
        {
            let flag = super::ItemFlag::default();
            assert!(!flag.keep());
            flag.set_keep();
            assert!(flag.keep());
            flag.clear_keep();
            assert!(!flag.keep());
            assert_eq!(
                flag.0.load(Ordering::SeqCst),
                ItemFlag::default().0.load(Ordering::SeqCst)
            );
        }

        {
            let flag = super::ItemFlag::default();
            assert!(!flag.countable());
            flag.set_countable();
            assert!(flag.countable());
            flag.clear_countable();
            assert!(!flag.countable());
            assert_eq!(
                flag.0.load(Ordering::SeqCst),
                ItemFlag::default().0.load(Ordering::SeqCst)
            );
        }

        {
            let flag = super::ItemFlag::default();
            assert!(!flag.deleted());
            flag.set_deleted();
            assert!(flag.deleted());
            flag.clear_deleted();
            assert!(!flag.deleted());
            assert_eq!(
                flag.0.load(Ordering::SeqCst),
                ItemFlag::default().0.load(Ordering::SeqCst)
            );
        }

        {
            let flag = super::ItemFlag::default();
            flag.set_keep();
            flag.set_countable();
            flag.set_deleted();
            assert!(flag.keep());
            assert!(flag.countable());
            assert!(flag.deleted());
            flag.clear_keep();
            flag.clear_countable();
            flag.clear_deleted();
            assert!(!flag.keep());
            assert!(!flag.countable());
            assert!(!flag.deleted());
            assert_eq!(
                flag.0.load(Ordering::SeqCst),
                ItemFlag::default().0.load(Ordering::SeqCst)
            );
        }
    }
}