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
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

/*
 * 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/>.
 */

//! Basic skip list options.

#[cfg(doc)]
use super::BasicLeaf;
use crate::options::{Fanout, NoSize, StoreKeys};
use core::marker::PhantomData;
use core::ops::{AddAssign, SubAssign};
use integral_constant::{Bool, Usize};

mod sealed {
    pub trait Sealed {}
}

/// Options trait for [`BasicLeaf::Options`].
///
/// This is a sealed trait; use the [`Options`] type, which implements this
/// trait.
pub trait BasicOptions: sealed::Sealed {
    /// The type that represents the size of an item in a [`SkipList`].
    ///
    /// See [`ListOptions::SizeType`](crate::ListOptions::SizeType).
    ///
    /// [`SkipList`]: crate::SkipList
    type SizeType: Clone + Default + Eq + AddAssign + SubAssign;

    /// Whether or not to store keys representing items in the internal parts
    /// of the list.
    ///
    /// See [`ListOptions::StoreKeys`](crate::ListOptions::StoreKeys).
    type StoreKeys: StoreKeys;

    /// The maximum amount of children each node in the list can have.
    ///
    /// If this is less than 3, it will be treated as 3.
    ///
    /// See [`ListOptions::Fanout`](crate::ListOptions::Fanout).
    type Fanout: Fanout;
}

/// Options for [`BasicLeaf::Options`].
///
/// This type implements [`BasicOptions`]. Type and const parameters correspond
/// to associated types in [`BasicOptions`] as follows; see those associated
/// types for documentation:
///
/// Parameter    | Associated type
/// ------------ | ---------------------------
/// `SizeType`   | [`BasicOptions::SizeType`]
/// `STORE_KEYS` | [`BasicOptions::StoreKeys`]
/// `FANOUT`     | [`BasicOptions::Fanout`]
#[rustfmt::skip]
pub type Options<
    SizeType = NoSize,
    const STORE_KEYS: bool = false,
    const FANOUT: usize = 8,
> = TypedOptions<
    SizeType,
    Bool<STORE_KEYS>,
    Usize<FANOUT>,
>;

/// Like [`Options`], but uses types instead of const parameters.
///
/// [`Options`] is actually a type alias of this type.
#[allow(clippy::type_complexity)]
#[rustfmt::skip]
pub struct TypedOptions<
    SizeType = NoSize,
    StoreKeys = Bool<false>,
    Fanout = Usize<8>,
>(PhantomData<fn() -> (
    SizeType,
    StoreKeys,
    Fanout,
)>);

#[rustfmt::skip]
impl<
    SizeType,
    StoreKeys,
    Fanout,
> sealed::Sealed for TypedOptions<
    SizeType,
    StoreKeys,
    Fanout,
> {}

#[rustfmt::skip]
impl<
    SizeType: Clone + Default + Eq + AddAssign + SubAssign,
    StoreKeys: self::StoreKeys,
    Fanout: self::Fanout,
> BasicOptions for TypedOptions<
    SizeType,
    StoreKeys,
    Fanout,
> {
    type SizeType = SizeType;
    type StoreKeys = StoreKeys;
    type Fanout = Fanout;
}