skippy 0.1.1

Highly flexible worst-case O(log n) intrusive skip list
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

/*
 * Copyright (C) 2025 taylor.fish <contact@taylor.fish>
 *
 * This file is part of Skippy.
 *
 * Skippy is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Skippy is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with Skippy. If not, see <https://www.gnu.org/licenses/>.
 */

use super::destroy_safety::can_safely_destroy;
use super::node::{Down, InternalNodeRef, LeafExt, LeafRef, Next, NodeRef};
use crate::allocator::Allocator;

/// Returns a node list that can be passed to [`destroy_node_list`].
pub fn deconstruct<L: LeafRef>(root: Down<L>) -> Option<InternalNodeRef<L>> {
    deconstruct_impl(root, None)
}

fn deconstruct_impl<L: LeafRef>(
    root: Down<L>,
    mut head: Option<InternalNodeRef<L>>,
) -> Option<InternalNodeRef<L>> {
    match root {
        Down::Leaf(mut node) => loop {
            let next = node.next_sibling();
            node.set_next_leaf(None);
            node = if let Some(next) = next {
                next
            } else {
                break;
            }
        },
        Down::Internal(mut node) => loop {
            if let Some(down) = node.down() {
                head = deconstruct_impl(down, head);
            }
            let next = node.next_sibling();
            node.set_next(head.map(Next::Sibling));
            head = Some(node);
            node = if let Some(next) = next {
                next
            } else {
                break;
            }
        },
    }
    head
}

/// # Safety
///
/// * Every node in the list must have been allocafed by `alloc`.
/// * There must be no other [`InternalNodeRef`]s that refer to any nodes in
///   the list.
pub unsafe fn destroy_node_list<L: LeafRef, A: Allocator>(
    head: &mut Option<InternalNodeRef<L>>,
    alloc: &A,
) {
    if !can_safely_destroy() {
        return;
    }
    while let Some(node) = head {
        let next = node.next_sibling();
        // SAFETY: Checked by caller.
        unsafe {
            node.dealloc(alloc);
        }
        *head = next;
    }
}