structdiff 0.7.3

zero-dependency crate for generating and applying partial diffs between struct instances
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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
use std::{
    cmp::Ordering::{Equal, Greater, Less},
    collections::VecDeque,
    ops::{Index, IndexMut, RangeBounds},
};

mod slots;

const MAX_SLOT_SIZE: usize = 16;
const BASE_SLOT_SIZE: usize = 8;
const UNDERSIZED_SLOT: usize = 1;

type Container<T> = slots::ArrayMap<T, MAX_SLOT_SIZE>;

#[cfg_attr(test, derive(Clone))]
pub struct Rope<T>(Vec<Container<T>>);

pub struct Iter<'rope, T> {
    self_ref: &'rope Rope<T>,
    key: usize,
    in_key: usize,
    exhausted: bool,
}
pub struct IntoIter<T> {
    self_own: VecDeque<slots::ArrayMap<T, MAX_SLOT_SIZE>>,
    internal: Option<<slots::ArrayMap<T, MAX_SLOT_SIZE> as IntoIterator>::IntoIter>,
}

impl<T> Index<usize> for Rope<T> {
    type Output = T;

    fn index(&self, index: usize) -> &Self::Output {
        let mut seen = 0;
        for entry in self.0.iter() {
            seen += entry.len();
            if seen > index {
                seen -= entry.len();
                return &entry[index - seen];
            }
        }
        panic!("Index is {index} but len is {seen}")
    }
}

impl<T> IndexMut<usize> for Rope<T> {
    fn index_mut(&mut self, index: usize) -> &mut T {
        let mut seen = 0;
        for entry in self.0.iter_mut() {
            seen += entry.len();
            if seen > index {
                seen -= entry.len();
                return &mut entry[index - seen];
            }
        }
        panic!("Index is {index} but len is {seen}")
    }
}

impl<'rope, T: 'rope> Iterator for Iter<'rope, T> {
    type Item = &'rope T;

    fn next(&mut self) -> Option<Self::Item> {
        if self.exhausted {
            return None;
        }

        let ret = &self.self_ref.0[self.key][self.in_key];

        self.in_key += 1;
        if self.in_key >= self.self_ref.0[self.key].len() {
            self.in_key = 0;
            self.key += 1;
        }

        if self.key >= self.self_ref.0.len() {
            self.exhausted = true;
        }

        Some(ret)
    }
}

impl<T> Iterator for IntoIter<T> {
    type Item = T;

    fn next(&mut self) -> Option<Self::Item> {
        if let ret @ Some(_) = self.internal.as_mut().and_then(|internal| internal.next()) {
            return ret;
        }

        while let Some(mut vec_iter) = self.self_own.pop_front().map(IntoIterator::into_iter) {
            let ret @ Some(_) = vec_iter.next() else {
                continue;
            };

            self.internal = Some(vec_iter);
            return ret;
        }

        None
    }
}

impl<T> IntoIterator for Rope<T> {
    type Item = T;

    type IntoIter = IntoIter<T>;

    fn into_iter(self) -> Self::IntoIter {
        IntoIter {
            self_own: self.0.into(),
            internal: None,
        }
    }
}

impl<'rope, T: 'rope> IntoIterator for &'rope Rope<T> {
    type Item = &'rope T;

    type IntoIter = Iter<'rope, T>;

    fn into_iter(self) -> Self::IntoIter {
        Iter {
            self_ref: self,
            key: 0,
            in_key: 0,
            exhausted: self.0.is_empty() || self.0[0].is_empty(),
        }
    }
}

impl<T> FromIterator<T> for Rope<T> {
    fn from_iter<C: IntoIterator<Item = T>>(iter: C) -> Self {
        let mut iter = iter.into_iter().peekable();
        let mut map = Vec::new();
        while iter.peek().is_some() {
            let arrmap = slots::ArrayMap::from_iter(iter.by_ref().take(8));
            map.push(arrmap);
            if map.last().unwrap().len() != 8 {
                break;
            }
        }

        Self(map)
    }
}

impl<T> Default for Rope<T> {
    fn default() -> Self {
        Self::new()
    }
}

impl<T> Rope<T> {
    pub fn new() -> Self {
        Self(Vec::from([slots::ArrayMap::new()]))
    }

    pub fn iter(&self) -> Iter<'_, T> {
        self.into_iter()
    }

    #[inline]
    fn _key_for_index(&self, index: usize) -> usize {
        let mut seen = 0;
        for (idx, entry) in self.0.iter().enumerate() {
            seen += entry.len();
            if seen > index {
                return idx;
            }
        }
        self.0.len()
    }

    #[inline]
    fn key_with_count_for_index(&self, index: usize) -> (usize, usize) {
        let mut seen = 0;
        for (idx, entry) in self.0.iter().enumerate() {
            seen += entry.len();
            if seen > index {
                seen -= entry.len();
                return (idx, seen);
            }
        }
        (self.0.len(), seen)
    }

    #[inline]
    fn key_with_count_for_index_from_prev(
        &self,
        index: usize,
        prev: usize,
        mut seen: usize,
    ) -> (usize, usize) {
        if seen > index {
            // it's in the same chunk, return early
            return (prev, seen);
        }
        for (idx, entry) in self.0.iter().enumerate().skip(prev) {
            seen += entry.len();
            if seen > index {
                seen -= entry.len();
                return (idx, seen);
            }
        }
        (self.0.len(), seen)
    }

    #[inline]
    pub fn len(&self) -> usize {
        self.0
            .iter()
            .map(slots::ArrayMap::len)
            .fold(0, std::ops::Add::add)
    }

    #[inline]
    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    fn rebalance_from_key(&mut self, start_key: usize) {
        let mut carry = VecDeque::with_capacity(16);
        let mut hold = Container::new();
        for key in start_key..(self.0.len()) {
            let entry = self.0.get_mut(key).unwrap();
            if entry.is_empty() {
                continue;
            }

            const LOW: usize = BASE_SLOT_SIZE - (BASE_SLOT_SIZE / 2);
            const HIGH: usize = BASE_SLOT_SIZE + (BASE_SLOT_SIZE / 2);
            if (LOW..=HIGH).contains(&entry.len()) && carry.is_empty() {
                break;
            }

            // put the empty holder in the list for now
            std::mem::swap(entry, &mut hold);

            // adjust size of hold, either taking elements from later chunks or carrying them
            match (hold.len().cmp(&BASE_SLOT_SIZE), carry.is_empty()) {
                (Less, carry_empty) => {
                    if !carry_empty {
                        carry.extend(hold.drain(..));
                        hold.extend(carry.drain(..BASE_SLOT_SIZE.min(carry.len())));
                    }

                    let mut iter = self.0.iter_mut().skip(key);
                    while let (Some(take_from), false) = (iter.next(), hold.len() == BASE_SLOT_SIZE)
                    {
                        hold.extend(take_from.drain(
                            ..(BASE_SLOT_SIZE.saturating_sub(hold.len())).min(take_from.len()),
                        ));
                    }
                }
                (Equal, true) => (),
                (Equal | Greater, false) => {
                    carry.extend(hold.drain(..));
                    hold.extend(carry.drain(..BASE_SLOT_SIZE.min(carry.len())));
                }
                (Greater, true) => {
                    carry.extend(hold.drain(BASE_SLOT_SIZE..));
                }
            }

            // take the empty holder back and leave the values in the map entry
            std::mem::swap(self.0.get_mut(key).unwrap(), &mut hold);
        }

        assert!(hold.is_empty());

        self.0.retain(|v| !v.is_empty());

        // fix up the last entry with any carried values
        match (carry.len(), self.0.last_mut()) {
            (0, ..) => {
                return;
            }
            (_, Some(l_entry)) => {
                l_entry.extend(
                    carry.drain(..(BASE_SLOT_SIZE.saturating_sub(l_entry.len())).min(carry.len())),
                );
            }
            _ => (),
        }

        // add any remaining carry values into new slots at the end
        while carry.len() > BASE_SLOT_SIZE {
            self.0.push(Container::from_iter(
                carry.drain(..BASE_SLOT_SIZE.min(carry.len())),
            ));
        }
        if !carry.is_empty() {
            self.0.push(Container::from_iter(carry));
        }
    }

    pub fn insert(&mut self, index: usize, element: T) {
        let (key, count) = self.key_with_count_for_index(index);
        if key == self.0.len() {
            self.0.push(Container::new());
        }
        let vec = self.0.get_mut(key).unwrap();
        vec.insert(index - count, element);
        if vec.len() == MAX_SLOT_SIZE {
            self.rebalance_from_key(key);
        }
    }

    pub fn remove(&mut self, index: usize) {
        let (key, count) = self.key_with_count_for_index(index);
        let Some(vec) = self.0.get_mut(key) else {
            panic!(
                "Failed to remove item with index {index} from rope with {} elements",
                self.len()
            );
        };
        vec.remove(index - count);
        if (0..=UNDERSIZED_SLOT).contains(&vec.len()) {
            self.rebalance_from_key(key.saturating_sub(1));
        }
    }

    pub fn drain<R>(&mut self, range: R)
    where
        R: RangeBounds<usize>,
    {
        use std::ops::Bound;

        let (l_idx, r_idx) = match (range.start_bound(), range.end_bound()) {
            (Bound::Included(l_i), Bound::Included(r_i)) => (*l_i, *r_i),
            (Bound::Included(l_i), Bound::Excluded(r_e)) => (*l_i, r_e - 1),
            (Bound::Included(l_i), Bound::Unbounded) => (*l_i, self.len() - 1),
            (Bound::Excluded(l_e), Bound::Included(r_i)) => (l_e + 1, *r_i),
            (Bound::Excluded(l_e), Bound::Excluded(r_e)) => (l_e + 1, r_e - 1),
            (Bound::Excluded(l_e), Bound::Unbounded) => (l_e + 1, self.len() - 1),
            (Bound::Unbounded, Bound::Included(r_i)) => (0, *r_i),
            (Bound::Unbounded, Bound::Excluded(r_e)) => (0, r_e - 1),
            (Bound::Unbounded, Bound::Unbounded) => (0, self.len() - 1),
        };

        let (l_key, l_key_count) = self.key_with_count_for_index(l_idx);
        let (r_key, r_key_count) =
            self.key_with_count_for_index_from_prev(r_idx, l_key, l_key_count);

        match l_key == r_key {
            true => {
                let v = self.0.get_mut(l_key).expect("we just looked this key up");
                v.drain((l_idx - l_key_count)..=(r_idx - l_key_count));
                if v.len() <= UNDERSIZED_SLOT {
                    self.rebalance_from_key(l_key.saturating_sub(1));
                }
            }
            false => {
                let l_mut = self.0.get_mut(l_key).unwrap();
                l_mut.drain((l_idx - l_key_count)..);
                let l_len = l_mut.len();
                let r_mut = self.0.get_mut(r_key).unwrap();
                r_mut.drain(..=(r_idx - r_key_count));
                let r_len = r_mut.len();
                let _ = self.0.drain((l_key + 1)..r_key);

                if l_len <= UNDERSIZED_SLOT || r_len <= UNDERSIZED_SLOT {
                    self.rebalance_from_key(l_key);
                }
            }
        }
    }

    pub fn swap(&mut self, a: usize, b: usize) {
        let [a, b] = [a.min(b), a.max(b)];
        let (l_key, l_key_count) = self.key_with_count_for_index(a);
        let (r_key, r_key_count) = self.key_with_count_for_index_from_prev(b, l_key, l_key_count);
        match l_key == r_key {
            true => self
                .0
                .get_mut(l_key)
                .unwrap()
                .swap(a - l_key_count, b - l_key_count),
            false => {
                let (l, r) = self.0.split_at_mut(r_key);
                std::mem::swap(&mut l[l_key][a - l_key_count], &mut r[0][b - r_key_count]);
            }
        }
    }
}

#[cfg(test)]
mod test {
    use nanorand::{Rng, WyRand};

    use super::{Rope, BASE_SLOT_SIZE, MAX_SLOT_SIZE};

    #[derive(Debug, Clone)]
    pub enum Mutation<T> {
        Insert(T, usize),
        Remove(usize),
        Swap(usize, usize),
        Drain(usize, usize),
    }

    pub(crate) trait Random {
        fn generate_random(rng: &mut WyRand) -> Self;
        fn generate_random_large(rng: &mut WyRand) -> Self;
        fn random_mutate(self, mutation: Mutation<String>) -> Self;
    }

    pub fn rand_string(rng: &mut WyRand) -> String {
        let base = vec![(); 8];
        base.into_iter()
            .map(|_| rng.generate_range::<u32, _>(65..=90))
            .filter_map(char::from_u32)
            .collect::<String>()
    }

    impl Mutation<String> {
        pub fn random_mutation(rng: &mut WyRand, len: usize) -> Option<Mutation<String>> {
            match rng.generate_range(0..4) {
                0 => Some(Self::Insert(rand_string(rng), rng.generate_range(0..=len))),
                1 => match len == 0 {
                    false => Some(Self::Remove(rng.generate_range(0..len))),
                    true => None,
                },
                2 => {
                    if len == 0 {
                        return None;
                    }
                    let l = rng.generate_range(0..len);
                    let r = rng.generate_range(0..len);
                    if l == r {
                        None
                    } else {
                        Some(Self::Swap(l, r))
                    }
                }
                3 => {
                    let l = rng.generate_range(0..len);
                    let r = rng.generate_range(l..len);
                    Some(Self::Drain(l, r))
                }
                _ => None,
            }
        }
    }

    impl Random for Vec<String> {
        fn generate_random(rng: &mut WyRand) -> Self {
            (0..rng.generate_range::<u8, _>(5..15))
                .map(|_| rand_string(rng))
                .collect()
        }

        fn generate_random_large(rng: &mut WyRand) -> Self {
            (0..rng.generate_range::<u16, _>(0..(u16::MAX / 5)))
                .map(|_| rand_string(rng))
                .collect()
        }

        fn random_mutate(mut self, mutation: Mutation<String>) -> Self {
            match mutation {
                Mutation::Insert(s, i) => self.insert(i, s),
                Mutation::Remove(i) => {
                    self.remove(i);
                }
                Mutation::Swap(l, r) => self.swap(l, r),
                Mutation::Drain(l, r) => {
                    self.drain(l..=r);
                }
            }
            self
        }
    }

    impl<T: std::fmt::Display> std::fmt::Display for Rope<T> {
        fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
            let mut seen = 0;
            for vals in self.0.iter() {
                write!(f, "{seen}: [")?;
                for val in vals {
                    write!(f, "{},", val)?;
                }
                writeln!(f, "];")?;
                seen += vals.len();
            }
            Ok(())
        }
    }

    impl Random for Rope<String> {
        fn generate_random(rng: &mut WyRand) -> Self {
            (0..rng.generate_range::<u8, _>(5..15))
                .map(|_| rand_string(rng))
                .collect()
        }

        fn generate_random_large(rng: &mut WyRand) -> Self {
            (0..rng.generate_range::<u16, _>(0..(u16::MAX / 5)))
                .map(|_| rand_string(rng))
                .collect()
        }

        fn random_mutate(mut self, mutation: Mutation<String>) -> Self {
            match mutation {
                Mutation::Insert(s, i) => self.insert(i, s),
                Mutation::Remove(i) => self.remove(i),
                Mutation::Swap(l, r) => self.swap(l, r),
                Mutation::Drain(l, r) => self.drain(l..=r),
            }
            self
        }
    }

    fn test(generator: impl Fn(&mut WyRand) -> Vec<String>, count: usize) {
        let mut rng = WyRand::new();
        let mut start_vec = generator(&mut rng);
        let mut start_rope = start_vec.clone().into_iter().collect::<Rope<_>>();
        assert_eq!(
            start_rope.clone().into_iter().collect::<Vec<_>>(),
            start_vec
        );
        for _ in 0..count {
            let prev_rope = start_rope.clone();
            let Some(mutation) = Mutation::random_mutation(&mut rng, start_vec.len()) else {
                continue;
            };

            let sr_clone = start_rope.clone();
            let mut_clone = mutation.clone();
            let result = std::panic::catch_unwind(|| {
                sr_clone.random_mutate(mut_clone);
            });

            let Ok(_) = result else {
                println!("{:?}", mutation);
                println!("prev_rope: {}", prev_rope);
                panic!("Caught panic");
            };

            start_rope = start_rope.random_mutate(mutation.clone());
            start_vec = start_vec.random_mutate(mutation.clone());

            if start_rope.clone().into_iter().collect::<Vec<_>>() != start_vec {
                println!("{:?}", mutation);
                println!("prev_rope: {}", prev_rope);
                println!("curr_rope: {}", start_rope);
            }
            pretty_assertions::assert_eq!(
                (&start_rope).into_iter().cloned().collect::<Vec<_>>(),
                start_rope.clone().into_iter().collect::<Vec<_>>()
            );
            pretty_assertions::assert_eq!(
                (&start_rope).into_iter().cloned().collect::<Vec<_>>(),
                start_vec
            );
        }
    }

    #[test]
    fn paired_small() {
        test(Vec::generate_random, 1_000_000)
    }

    #[test]
    fn paired_large() {
        test(Vec::generate_random_large, 100_000)
    }

    #[test]
    #[should_panic]
    fn get_from_empty() {
        #[expect(clippy::unnecessary_operation)]
        Rope::<()>::new()[0];
    }

    #[test]
    #[should_panic]
    fn get_past_end() {
        #[expect(clippy::unnecessary_operation)]
        Rope::<()>::from_iter([(), ()])[2];
    }

    #[test]
    fn get_last() {
        for i in 1..33 {
            assert_eq!(
                Rope::from_iter(vec![(); i].into_iter().enumerate().map(|(i, _)| i))[i - 1],
                i - 1
            );
        }
    }

    #[test]
    fn delete_rebalance() {
        let arr_map = {
            let mut collection = Rope::from_iter((0..).take(BASE_SLOT_SIZE));
            for i in (BASE_SLOT_SIZE..).take(9) {
                collection.insert(i, i);
            }
            collection.remove(MAX_SLOT_SIZE);
            collection
        };

        let vec = {
            let mut collection = Vec::from_iter((0..).take(BASE_SLOT_SIZE));
            for i in (BASE_SLOT_SIZE..).take(9) {
                collection.insert(i, i);
            }

            collection.remove(MAX_SLOT_SIZE);
            collection
        };

        assert_eq!(
            vec.iter().collect::<Vec<_>>(),
            arr_map.iter().collect::<Vec<_>>()
        );
        assert_eq!(
            vec.into_iter().collect::<Vec<_>>(),
            arr_map.into_iter().collect::<Vec<_>>()
        );
    }
}