Rust Rc 方法整理

Rust · 發表 2019-05-12 18:34:23

摘要： ref:alloc::rc::Rc - Rust   std::rc::Rc 是單執行緒引用計數指標。'RC' 代表 'Refe...

ref:alloc::rc::Rc - Rust

std::rc::Rc 是單執行緒 引用計數指標。'RC' 代表 'Reference Counted'。

翻閱module-level-documentation 檢視更多資訊

Rc 的固有方法都是關聯函式，這意味在使用應該是用類似Rc::get_mut(&mut value) 而不是value.get_mut() 的方式呼叫。這可以避免與其包含的型別方法衝突。

方法

new

pub fn new(value: T) -> Rc<T>

構造一個Rc<T>

例子

use std::rc::Rc;

let five = Rc::new(5);

pub fn pin(value: T) -> Pin<Rc<T>>

構建一個新的Pin<Rc<T>> 。如果 T 沒有實現 Unpin，那麼 value 將會固定在記憶體中不可移動。

try_unwrap

pub fn try_unwrap(this: Self) -> Result<T, Self>

如果 Rc 有且只有1個強引用，則返回包含的值，否則返回Err<T> 。

不管 Rc 有多少弱引用，只要符合上述條件，該函式都將成功。

use std::rc::Rc;

fn main() {
let x = Rc::new(3);
assert_eq!(Rc::try_unwrap(x), Ok(3));

let x = Rc::new(4);
let _y = Rc::clone(&x); // 呼叫 clone 增強強引用
assert_eq!(*Rc::try_unwrap(x).unwrap_err(), 4); // Rc::try_unwrap(x) 返回 Err(4)
}

into_raw

pub fn into_raw(this: Self) -> *const T

消費 Rc, 返回被包裝的指標。

為了避免記憶體洩漏，被包裝的指標如果要被重新轉換為 Rc, 應該使用Rc::from_raw

例子

use std::rc::Rc;

fn main() {
let x = Rc::new(4);
let x_ptr = Rc::into_raw(x); // x_ptr 為裸指標 0x142fdcde020
assert_eq!(unsafe { *x_ptr }, 4);
}

from_raw

pub unsafe fn from_raw(ptr: *const T) -> Self

從裸指標中構建一個 Rc。

裸指標必須是從Rc::into_raw 中返回的裸指標。

這個函式是不安全的，因為不正確使用可能會導致記憶體問題。例如，在裸指標上二次釋放資源。

use std::rc::Rc;

let x = Rc::new(10);
let x_ptr = Rc::into_raw(x);

unsafe {
// 轉換成 Rc 避免記憶體洩漏
let x = Rc::from_raw(x_ptr);
assert_eq!(*x, 10);

// 再次呼叫 `Rc::from_row(x_ptr)` 會導致記憶體不安全
}

// `x` 的記憶體將會在離開作用域後釋放，所以 `x_ptr` 不是懸吊指標

downgrade

pub fn downgrade(this: &Self) -> Weak<T>

建立一個被包裹值的弱引用指標

例子

use std::rc::Rc;

let five = Rc::new(5);

let weak_five = Rc::downgrade(&five);

weak_count

返回弱引用計數

例子

use std::rc::Rc;

let five = Rc::new(5);
let _weak_five = Rc::downgrade(&five);

assert_eq!(1, Rc::weak_cont(&five));

strong_count

返回強引用計數

例子

use std::rc::Rc;

let five = Rc::new(5);
let _also_five = Rc::clone(&five);

assert_eq!(2, Rc::strong_count(&five));

get_mut

如果沒有其他 Rc 或者 Weak 指標指向內部值，則返回內部值的可變引用，否則返回

None，因為改變共享值是不安全的。

另見make_mut ，這方法會在內部值處於共享狀態時克隆內部值。

例子

use std::rc::Rc;

let mut x = Rc::new(3);
*Rc::get_mut(&mut x).unwrap() = 4;
assert_eq!(*x, 4);

let _y = Rc::clone(&x);
assert!(Rc::get_mut(&mut x).is_none());

ptr_eq

判斷兩個指標是否指向同一個值

例子

use std::rc::Rc;

let five = Rc::new(5);
let same_five = Rc::clone(&five);
let other_five = Rc::new(5);

assert!(Rc::ptr_eq(&five, &same_file));
assert!(!Rc::ptr_eq(&five, &other_file));

make_mut

pub fn make_mut(this: &mut Self) -> &mut T

建立一個 Rc 的可變引用。如果 Rc 還有其他引用或弱引用，make_mut 將會克隆內部值以保證所有權的唯一性。這也被稱為寫時克隆。

另見get_mut ，這個方法會失敗而不是克隆

例子

use std::rc::Rc;

let mut data = Rc::new(5);

*Rc::make_mut(&mut data) += 1; // 不會克隆
let mut other_data = Rc::clone(&data); //此時還未複製
*Rc::make_mut(&mut data) += 1; // 複製內部資料
*Rc::make_mut(&mut data) += 1; // 複製後再次呼叫原指標將不會觸發克隆
*Rc::make_mut(&mut other_data) *= 2;

// 現在 `data` 和 `other_data` 指向不同值
assert_eq!(*data, 8);
assert_eq!(*other_data, 12);

downcast

pub fn downcast<T: Any>(self) -> Result<Rc<T>, Rc<dyn Any>>

嘗試將 Rc<dyn Any> 降級為具體值

例子

use std::any::Any;
use std::rc::Rc;

fn print_if_string(value: Rc<dyn Any>) {
if let Ok(string) = value.downcast::<String>() {
println!("String ({}): {}", string.len(), string);
}
}

fn main() {
let my_string = "Hello World".to_string();
print_if_string(Rc::new(my_string));
print_if_string(Rc::new(0i8)); // 不會列印
}