linked_list_r4l 0.5.0

Linked lists that supports arbitrary removal in constant time
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

#![cfg_attr(not(test), no_std)]
#![doc = include_str!("../README.md")]

mod linked_list;
mod raw_list;
pub use linked_list::List;
pub use raw_list::{GetLinks, Links, RawList};

#[macro_export(local_inner_macros)]
#[doc(hidden)]
macro_rules! __def_node_internal {
    ($(#[$meta:meta])* $vis:vis struct $name:ident($type:ty);) => {
        $(#[$meta])*
        $vis struct $name {
            inner: $type,
            links: $crate::Links<Self>,
        }

        impl $crate::GetLinks for $name {
            type EntryType = Self;

            #[inline]
            fn get_links(t: &Self) -> &$crate::Links<Self> {
                &t.links
            }
        }

        impl $name {
            #[doc = "Create a node"]
            pub const fn new(inner: $type) -> Self {
                Self {
                    inner,
                    links: $crate::Links::new(),
                }
            }

            #[inline]
            #[doc = "Return the referece of wrapped inner"]
            pub const fn inner(&self) -> &$type {
                &self.inner
            }

            #[inline]
            #[doc = "Consumes the `node`, returning the wrapped inner"]
            pub fn into_inner(self) -> $type {
                self.inner
            }
        }

        impl core::ops::Deref for $name {
            type Target = $type;

            #[inline]
            fn deref(&self) -> &Self::Target {
                &self.inner
            }
        }
    };

    ($(#[$meta:meta])* $vis:vis struct $name:ident<$gen:ident>($type:ty);) => {
        $(#[$meta])*
        $vis struct $name<$gen> {
            inner: $type,
            links: $crate::Links<Self>,
        }

        impl<$gen> $crate::GetLinks for $name<$gen> {
            type EntryType = Self;

            #[inline]
            fn get_links(t: &Self) -> &$crate::Links<Self> {
                &t.links
            }
        }

        impl<$gen> $name<$gen> {
            #[doc = "Create a node"]
            pub const fn new(inner: $type) -> Self {
                Self {
                    inner,
                    links: $crate::Links::new(),
                }
            }

            #[inline]
            #[doc = "Return the referece of wrapped inner"]
            pub const fn inner(&self) -> &$type {
                &self.inner
            }

            #[inline]
            #[doc = "Consumes the `node`, returning the wrapped inner"]
            pub fn into_inner(self) -> $type {
                self.inner
            }
        }

        impl<$gen> core::ops::Deref for $name<$gen> {
            type Target = $type;

            #[inline]
            fn deref(&self) -> &Self::Target {
                &self.inner
            }
        }
    };
}

/// A macro for create a node type that can be used in List.
///
/// # Syntax
///
/// ```ignore
/// def_node! {
/// /// A node with usize value.
/// [pub] struct UsizedNode(usize);
/// /// A node with generic inner type.
/// [pub] struct WrapperNode<T>(T);
/// }
/// ```
///
/// # Example
///
/// ```rust
/// use linked_list_r4l::{List, def_node};
///
/// def_node! {
///     /// An example Node with usize
///     struct ExampleNode(usize);
///     /// An example Node with generic Inner type and pub(crate)
///     pub(crate) struct NativeGenericNode(usize);
///     /// An example Node with generic Inner type and pub vis
///     pub struct GenericNode<T>(T);
/// }
///
/// let node1 = Box::new(ExampleNode::new(0));
/// let node2 = Box::new(ExampleNode::new(1));
/// let mut list = List::<Box<ExampleNode>>::new();
///
/// list.push_back(node1);
/// list.push_back(node2);
///
/// for (i, e) in list.iter().enumerate() {
///     assert!(*e.inner() == i);
/// }
///
/// let node1 = list.pop_front().unwrap();
/// let node2 = list.pop_front().unwrap();
///
/// assert!(node1.into_inner() == 0);
/// assert!(node2.into_inner() == 1);
/// assert!(list.pop_front().is_none());
///
/// let node1 = Box::new(GenericNode::new(0));
/// let node2 = Box::new(GenericNode::new(1));
///
/// let mut list = List::<Box<GenericNode<usize>>>::new();
///
/// list.push_back(node1);
/// list.push_back(node2);
///
/// for (i, e) in list.iter().enumerate() {
///     assert!(*e.inner() == i);
/// }
/// ```
#[macro_export(local_inner_macros)]
macro_rules! def_node {
    ($(#[$meta:meta])* $vis:vis struct $name:ident($type:ty); $($t:tt)*) => {
        __def_node_internal!($(#[$meta])* $vis struct $name($type););
        def_node!($($t)*);
    };
    ($(#[$meta:meta])* $vis:vis struct $name:ident<$gen:ident>($type:ty); $($t:tt)*) => {
        __def_node_internal!($(#[$meta])* $vis struct $name<$gen>($type););
        def_node!($($t)*);
    };
    () => ()
}