orx_linked_list/
variant.rs

1use crate::memory::{DoublyReclaimer, SinglyReclaimer};
2use core::marker::PhantomData;
3use orx_selfref_col::{MemoryReclaimer, RefsArray, RefsNone, RefsSingle, Variant};
4
5pub trait ListVariant: Variant {
6    type Reclaimer: MemoryReclaimer<Self>;
7}
8
9/// A self referential collection variant representing a singly linked list
10/// where nodes hold a reference to the next element, but not to the previous.
11pub struct Singly<T> {
12    p: PhantomData<T>,
13}
14
15/// # SAFETY
16///
17/// List variants do not hold any data, safe to send or sync.
18unsafe impl<T> Sync for Singly<T> {}
19
20impl<T> Variant for Singly<T> {
21    type Item = T;
22
23    type Prev = RefsNone;
24
25    type Next = RefsSingle<Self>;
26
27    type Ends = RefsSingle<Self>;
28}
29
30impl<T> ListVariant for Singly<T> {
31    type Reclaimer = SinglyReclaimer;
32}
33
34/// A self referential collection variant representing a doubly linked list
35/// where nodes hold a reference to the next element, and a reference to the previous.
36pub struct Doubly<T> {
37    p: PhantomData<T>,
38}
39
40/// # SAFETY
41///
42/// List variants do not hold any data, safe to send or sync.
43unsafe impl<T> Sync for Doubly<T> {}
44
45impl<T> Variant for Doubly<T> {
46    type Item = T;
47
48    type Prev = RefsSingle<Self>;
49
50    type Next = RefsSingle<Self>;
51
52    type Ends = RefsArray<2, Self>;
53}
54
55impl<T> ListVariant for Doubly<T> {
56    type Reclaimer = DoublyReclaimer;
57}