BurritOS/src/utility/list.rs

217 lines
5.0 KiB
Rust
Raw Normal View History

2023-02-15 18:10:08 +01:00
2023-03-01 16:55:17 +01:00
pub struct List<T: PartialEq> {
head: Link<T>,
2023-02-15 18:10:08 +01:00
}
2023-03-01 16:55:17 +01:00
type Link<T> = Option<Box<Node<T>>>;
struct Node<T> {
elem: T,
next: Link<T>,
2023-02-15 18:10:08 +01:00
}
2023-03-01 16:55:17 +01:00
impl<T: PartialEq> List<T> {
pub fn new() -> Self {
List { head: None }
}
2023-02-15 18:10:08 +01:00
2023-03-01 16:55:17 +01:00
/// Push an item at the end of the list
pub fn push(&mut self, elem: T) {
let new_node = Box::new(Node {
elem: elem,
next: self.head.take(),
});
2023-02-15 18:10:08 +01:00
2023-03-01 16:55:17 +01:00
self.head = Some(new_node);
}
2023-02-15 18:10:08 +01:00
2023-03-01 16:55:17 +01:00
/// Retrieve and remove the item at the end of the list.
///
/// Return None if list is empty
pub fn pop(&mut self) -> Option<T> {
self.head.take().map(|node| {
self.head = node.next;
node.elem
})
2023-02-15 18:10:08 +01:00
}
2023-03-01 16:55:17 +01:00
/// Retrieve without removing the item at the end of the list
///
/// Return None if list is empty
pub fn peek(&self) -> Option<&T> {
self.head.as_ref().map(|node| {
&node.elem
})
2023-02-15 18:10:08 +01:00
}
2023-03-01 16:55:17 +01:00
/// Retrieve without removing the item at the end of the list as mutable
///
/// Return None if lsit is empty
pub fn peek_mut(&mut self) -> Option<&mut T> {
self.head.as_mut().map(|node| {
&mut node.elem
})
2023-02-15 18:10:08 +01:00
}
2023-03-01 16:55:17 +01:00
/// Search for an element in the list
///
/// Return **bool** true if the list contains the element, false otherwise
///
/// Worst case complexity of this function is O(n)
pub fn contains(&self, elem: &T) -> bool {
let mut iter = self.iter();
let element = iter.next();
while element.is_some() {
if element.unwrap() == elem {
return true;
}
2023-02-15 18:10:08 +01:00
}
2023-03-01 16:55:17 +01:00
false
2023-02-15 18:10:08 +01:00
}
2023-03-01 16:55:17 +01:00
pub fn into_iter(self) -> IntoIter<T> {
IntoIter(self)
2023-02-15 18:10:08 +01:00
}
2023-03-01 16:55:17 +01:00
pub fn iter(&self) -> Iter<'_, T> {
Iter { next: self.head.as_deref() }
2023-02-15 18:10:08 +01:00
}
2023-03-01 16:55:17 +01:00
pub fn iter_mut(&mut self) -> IterMut<'_, T> {
IterMut { next: self.head.as_deref_mut() }
2023-02-15 18:10:08 +01:00
}
}
2023-03-01 16:55:17 +01:00
impl<T: PartialEq> Drop for List<T> {
2023-02-15 18:10:08 +01:00
fn drop(&mut self) {
2023-03-01 16:55:17 +01:00
let mut cur_link = self.head.take();
while let Some(mut boxed_node) = cur_link {
cur_link = boxed_node.next.take();
2023-02-15 18:10:08 +01:00
}
}
}
2023-03-01 16:55:17 +01:00
pub struct IntoIter<T: PartialEq>(List<T>);
2023-02-17 09:45:47 +01:00
2023-03-01 16:55:17 +01:00
impl<T: PartialEq> Iterator for IntoIter<T> {
type Item = T;
fn next(&mut self) -> Option<Self::Item> {
// access fields of a tuple struct numerically
self.0.pop()
2023-02-17 09:45:47 +01:00
}
}
2023-03-01 16:55:17 +01:00
pub struct Iter<'a, T> {
next: Option<&'a Node<T>>,
2023-02-17 09:45:47 +01:00
}
2023-03-01 16:55:17 +01:00
impl<'a, T> Iterator for Iter<'a, T> {
type Item = &'a T;
fn next(&mut self) -> Option<Self::Item> {
self.next.map(|node| {
self.next = node.next.as_deref();
&node.elem
})
2023-02-17 09:45:47 +01:00
}
}
2023-03-01 16:55:17 +01:00
pub struct IterMut<'a, T> {
next: Option<&'a mut Node<T>>,
}
impl<'a, T> Iterator for IterMut<'a, T> {
type Item = &'a mut T;
2023-02-17 09:45:47 +01:00
fn next(&mut self) -> Option<Self::Item> {
2023-03-01 16:55:17 +01:00
self.next.take().map(|node| {
self.next = node.next.as_deref_mut();
&mut node.elem
})
2023-02-17 09:45:47 +01:00
}
}
2023-03-01 16:55:17 +01:00
#[cfg(test)]
mod test {
use super::List;
#[test]
fn basics() {
let mut list = List::new();
// Check empty list behaves right
assert_eq!(list.pop(), None);
// Populate list
list.push(1);
list.push(2);
list.push(3);
// Check normal removal
assert_eq!(list.pop(), Some(3));
assert_eq!(list.pop(), Some(2));
// Push some more just to make sure nothing's corrupted
list.push(4);
list.push(5);
// Check normal removal
assert_eq!(list.pop(), Some(5));
assert_eq!(list.pop(), Some(4));
// Check exhaustion
assert_eq!(list.pop(), Some(1));
assert_eq!(list.pop(), None);
2023-02-17 09:45:47 +01:00
}
2023-03-01 16:55:17 +01:00
#[test]
fn peek() {
let mut list = List::new();
assert_eq!(list.peek(), None);
assert_eq!(list.peek_mut(), None);
list.push(1); list.push(2); list.push(3);
2023-02-17 09:45:47 +01:00
2023-03-01 16:55:17 +01:00
assert_eq!(list.peek(), Some(&3));
assert_eq!(list.peek_mut(), Some(&mut 3));
2023-02-15 18:10:08 +01:00
2023-03-01 16:55:17 +01:00
list.peek_mut().map(|value| {
*value = 42
});
assert_eq!(list.peek(), Some(&42));
assert_eq!(list.pop(), Some(42));
}
#[test]
fn into_iter() {
let mut list = List::new();
list.push(1); list.push(2); list.push(3);
let mut iter = list.into_iter();
assert_eq!(iter.next(), Some(3));
assert_eq!(iter.next(), Some(2));
assert_eq!(iter.next(), Some(1));
assert_eq!(iter.next(), None);
}
2023-02-15 18:10:08 +01:00
#[test]
2023-03-01 16:55:17 +01:00
fn iter() {
let mut list = List::new();
list.push(1); list.push(2); list.push(3);
let mut iter = list.iter();
assert_eq!(iter.next(), Some(&3));
assert_eq!(iter.next(), Some(&2));
assert_eq!(iter.next(), Some(&1));
2023-02-15 18:10:08 +01:00
}
2023-03-01 16:55:17 +01:00
#[test]
fn iter_mut() {
let mut list = List::new();
list.push(1); list.push(2); list.push(3);
let mut iter = list.iter_mut();
assert_eq!(iter.next(), Some(&mut 3));
assert_eq!(iter.next(), Some(&mut 2));
assert_eq!(iter.next(), Some(&mut 1));
}
2023-02-15 18:10:08 +01:00
}