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

/*
 * @Copyright 2020 Jason Carr
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

use super::Ix;
use alloc::{boxed::Box, vec::Vec};

/**
 * Trait to expose contained indices to the garbage collector.
 */
pub trait HasIx<T: 'static> {
    /**
     * Expose a mutable reference to every Ix owned
     * by this datastructure. Any Ix which is not
     * exposed by this function will be invalidated
     * by a garbage collection. The object which
     * was pointed to may also have been collected.
     *
     * If some Ix is owned by two or more instances of
     * this type (such as via Rc<Cell<...>>),
     * then the situation is tricker. Because
     * this is an uncommon use case, and because
     * enforcing uniqueness in the collector would
     * create additional space and time overheads,
     * ensuring uniqueness is a requirement of the implementer.
     *
     * Avoid panicking in this method. A panic may
     * cause some elements to never be dropped, leaking
     * any owned memory outside the region.
     *
     * Likewise, avoid modifying the set of indices in this
     * function. Failure to do so may cause later methods
     * relying on the consistency of this method to panic,
     * or possibly leak.
     */
    fn foreach_ix<'b, 'a: 'b, F>(&'a mut self, f: F)
    where
        F: FnMut(&'b mut Ix<T>);
}
impl<T: 'static, S: HasIx<T>> HasIx<T> for Vec<S> {
    fn foreach_ix<'b, 'a: 'b, F>(&'a mut self, mut f: F)
    where
        F: FnMut(&'b mut Ix<T>),
    {
        self.iter_mut().for_each(|o| o.foreach_ix(&mut f));
    }
}
impl<T: 'static> HasIx<T> for () {
    fn foreach_ix<'b, 'a: 'b, F>(&'a mut self, mut _f: F)
    where
        F: FnMut(&'b mut Ix<T>),
    {
    }
}
impl<T: 'static, S1: HasIx<T>, S2: HasIx<T>> HasIx<T> for (S1, S2) {
    fn foreach_ix<'b, 'a: 'b, F>(&'a mut self, mut f: F)
    where
        F: FnMut(&'b mut Ix<T>),
    {
        self.0.foreach_ix(&mut f);
        self.1.foreach_ix(&mut f);
    }
}
impl<T: 'static, S1: HasIx<T>, S2: HasIx<T>, S3: HasIx<T>> HasIx<T> for (S1, S2, S3) {
    fn foreach_ix<'b, 'a: 'b, F>(&'a mut self, mut f: F)
    where
        F: FnMut(&'b mut Ix<T>),
    {
        self.0.foreach_ix(&mut f);
        self.1.foreach_ix(&mut f);
        self.2.foreach_ix(&mut f);
    }
}
impl<T: 'static, S1: HasIx<T>, S2: HasIx<T>, S3: HasIx<T>, S4: HasIx<T>> HasIx<T>
    for (S1, S2, S3, S4)
{
    fn foreach_ix<'b, 'a: 'b, F>(&'a mut self, mut f: F)
    where
        F: FnMut(&'b mut Ix<T>),
    {
        self.0.foreach_ix(&mut f);
        self.1.foreach_ix(&mut f);
        self.2.foreach_ix(&mut f);
        self.3.foreach_ix(&mut f);
    }
}
impl<T: 'static, S: HasIx<T>> HasIx<T> for Option<S> {
    fn foreach_ix<'b, 'a: 'b, F>(&'a mut self, mut f: F)
    where
        F: FnMut(&'b mut Ix<T>),
    {
        self.iter_mut().for_each(|o| o.foreach_ix(&mut f))
    }
}
impl<T: 'static, S: HasIx<T>> HasIx<T> for Box<S> {
    fn foreach_ix<'b, 'a: 'b, F>(&'a mut self, mut f: F)
    where
        F: FnMut(&'b mut Ix<T>),
    {
        self.as_mut().foreach_ix(&mut f);
    }
}
impl<T: 'static, S: HasIx<T>> HasIx<T> for &mut S {
    fn foreach_ix<'b, 'a: 'b, F>(&'a mut self, mut f: F)
    where
        F: FnMut(&'b mut Ix<T>),
    {
        (*self).foreach_ix(&mut f);
    }
}
impl<T: 'static> HasIx<T> for Ix<T> {
    fn foreach_ix<'b, 'a: 'b, F>(&'a mut self, mut f: F)
    where
        F: FnMut(&'b mut Ix<T>),
    {
        f(self);
    }
}