019 通過連結清單學Rust之雙連結清單實作Peek

介紹

視訊位址：https://www.bilibili.com/video/av78062009/

相關源碼：https://github.com/anonymousGiga/Rust-link-list

詳細内容

本節我們實作雙連結清單的Peek。

實作peek

根據我們在之前實作單連結清單的經驗，我們很容易想到我們的peek函數怎麼實作，如下：

pub fn peek_front(&self) -> Option<&T> {
    self.head.as_ref().map(|node| {
      &node.borrow().elem
    })
  }      

編譯，發現會報錯。

解決辦法，我們可以檢視手冊上RefCell的borrow函數，發現定義如下：

pub fn borrow(&self) -> Ref<'_, T>

pub fn borrow_mut(&self) -> RefMut<'_, T>      

那我們将代碼改為如下：

pub fn peek_front(&self) -> Option<Ref<T>> {
    self.head.as_ref().map(|node| {
      node.borrow()
    })
  }      

編譯，發現仍然報錯，找不到Ref，則在代碼中添加如下：

use std::cell::Ref;      

繼續報錯，報錯情況如下：

= note: expected enum `std::option::Option<std::cell::Ref<'_, T>>`
              found enum `std::option::Option<std::cell::Ref<'_, Node<T>>>`      

期望的是

std::option::Option<std::cell::Ref<'_, T>>      

但是此處得到的是

std::option::Option<std::cell::Ref<'_, Node<T>>>      

很容易發現，我們需要将

Node<T>      

中的T拿出來。

此時該如何解決呢？

這裡我們就使用到

std::cell::ref      

pub fn map<U, F>(orig: Ref<'b, T>, f: F) -> Ref<'b, U>
where
    F: FnOnce(&T) -> &U,
    U: ?Sized,      

pub fn peek_front(&self) -> Option<Ref<T>> {
    self.head.as_ref().map(|node| {
      Ref::map(node.borrow(), |node| &node.elem)
    })
  }      

測試代碼

#[test]
fn peek() {
    let mut list = List::new();
    assert!(list.peek_front().is_none());
    list.push_front(1); list.push_front(2); list.push_front(3);

    assert_eq!(&*list.peek_front().unwrap(), &3);
}      

完整代碼

use std::rc::Rc;
use std::cell::{Ref, RefCell};

pub struct List<T> {
    head: Link<T>,
    tail: Link<T>,
}

type Link<T> = Option<Rc<RefCell<Node<T>>>>;

struct Node<T> {
    elem: T,
    next: Link<T>,
    prev: Link<T>,
}

impl<T> Node<T> {
    fn new(elem: T) -> Rc<RefCell<Self>> {
        Rc::new(RefCell::new(Node {
            elem: elem,
            prev: None,
            next: None,
        }))
    }
}

impl<T> List<T> {
    pub fn new() -> Self {
        List { head: None, tail: None }
    }

    pub fn push_front(&mut self, elem: T) {
        let node = Node::new(elem);
        match self.head.take() {
            Some(head) => {
                //取可變引用使用borrow_mut
                head.borrow_mut().prev = Some(node.clone());
                node.borrow_mut().next = Some(head);
                self.head = Some(node);
            }
            None => {
                self.tail = Some(node.clone());
                self.head = Some(node);
            }
        }
    }

    pub fn pop_front(&mut self) -> Option<T> {
        self.head.take().map(|node| {
            match node.borrow_mut().next.take() {
                Some(next) => {
                    next.borrow_mut().prev.take();
                    self.head = Some(next);
                }
                None => {
                    self.tail.take();
                }
            }
            //取值使用into_inner
            Rc::try_unwrap(node).ok().unwrap().into_inner().elem
        })
    }

    //pub fn peek_front(&self) -> Option<&T> {
    pub fn peek_front(&self) -> Option<Ref<T>> {
        self.head.as_ref().map(|node| {
            //node.borrow()
            Ref::map(node.borrow(), |node| &node.elem)
        })
    }
}

#[cfg(test)]
mod tests {
    use super::List;

    #[test]
    fn basics() {
        let mut list = List::new();

        assert_eq!(list.pop_front(), None);

        list.push_front(1);
        list.push_front(2);
        list.push_front(3);

        assert_eq!(list.pop_front(), Some(3));
        assert_eq!(list.pop_front(), Some(2));

        list.push_front(4);
        list.push_front(5);

        assert_eq!(list.pop_front(), Some(5));
        assert_eq!(list.pop_front(), Some(4));

        assert_eq!(list.pop_front(), Some(1));
        assert_eq!(list.pop_front(), None);
    }
}