本书github链接:inside-rust-std-library
前面章节参见:
深入RUST标准库内核(序言) - 简书 (jianshu.com)
深入RUST标准库内核(一 概述) - 简书 (jianshu.com)
深入RUST标准库内核(二 内存)—Layout/原生指针 - 简书 (jianshu.com)
深入RUST标准库内核(二 内存)—NonNull<T>/申请及释放 - 简书 (jianshu.com)
深入RUST标准库内核(二 内存)—mem模块/MaybeUninit<T> - 简书 (jianshu.com)
深入RUST标准库内核 (三 基础Trait) 编译器内置Trait - 简书 (jianshu.com)
深入RUST标准库内核(三 基础Trait)— Ops Trait - 简书 (jianshu.com)
深入RUST标准库内核(三 基本Trait)—Range - 简书 (jianshu.com)
深入RUST标准库内核(三 基础Trait)—Index Trait - 简书 (jianshu.com)
深入RUST标准库内核(四 Iterator 实现)— Range实现 - 简书 (jianshu.com)
深入RUST标准库内核(四 Iterator)— Slice实现 - 简书 (jianshu.com)
字符串Iterator代码分析
题外话,&str.len()返回字符串切片字节占用数,&str.chars().count()返回字符数目。
字符串切片获取Iterator有如下3个函数
&str::chars() 获得以UTF-8编码的字符串的Iterator
&str::bytes() 获得一个[u8]的Iterator
&str::char_indices() 获得一个元组,第一个成员是字符字节数组的序号,第二个成员是字符本身
bytes()主要用于提高在程序员确定采用ASCII字符串下的运行效率。
我们以&str::chars()的Iterator来看一下具体的实现
pub struct Chars<'a> {
//利用slice通用的iter做实例化,实际是一个adapter设计模式
pub(super) iter: slice::Iter<'a, u8>,
}
pub fn chars(&self) -> Chars<'_> {
//self.as_bytes()获得一个&[u8]
Chars { iter: self.as_bytes().iter() }
}
impl<'a> Iterator for Chars<'a> {
type Item = char;
fn next(&mut self) -> Option<char> {
//next_code_point见后面代码分析
next_code_point(&mut self.iter).map(|ch| {
unsafe { char::from_u32_unchecked(ch) }
})
}
fn count(self) -> usize {
// 利用切片iterator的filter来实现
self.iter.filter(|&&byte| !utf8_is_cont_byte(byte)).count()
}
fn size_hint(&self) -> (usize, Option<usize>) {
let len = self.iter.len();
//最少按四个字节一个字符,最多按一个字节一个字符
((len + 3) / 4, Some(len))
}
fn last(mut self) -> Option<char> {
self.next_back()
}
}
pub fn next_code_point<'a, I: Iterator<Item = &'a u8>>(bytes: &mut I) -> Option<u32> {
// iterator.next
let x = *bytes.next()?;
if x < 128 {
//ascii字符
return Some(x as u32);
}
//因为是字符串,此时第二个字节一定会有
let init = utf8_first_byte(x, 2);
//获取下一个字节,一定存在
let y = unwrap_or_0(bytes.next());
let mut ch = utf8_acc_cont_byte(init, y);
if x >= 0xE0 {
// 三个字节的UTF-8
let z = unwrap_or_0(bytes.next());
let y_z = utf8_acc_cont_byte((y & CONT_MASK) as u32, z);
ch = init << 12 | y_z;
if x >= 0xF0 {
//四个字节的UTF-8
let w = unwrap_or_0(bytes.next());
ch = (init & 7) << 18 | utf8_acc_cont_byte(y_z, w);
}
}
Some(ch)
}
&str的Iterator实现是一个说明Iterator设计模式优越性的经典实例。如果直接使用循环,则&str与&[T]必然会有很多的重复代码,使用Iterator模式后,重复代码被抽象到了Iterator模块中。&str复用了&[T]的iter。
array 的Iterator实现
Unsize Trait
pub trait Unsize<T: ?Sized> {
// Empty.
}
实现了Unsize Trait,可以把一个固定内存大小的变量强制转换为相关的可变大小类型, 如[T;N]实现了Unsize<[T]>, 因此[T;N]可以转换为[T],一般是指针转换。
Iter所用的结构
pub struct IntoIter<T, const N: usize> {
/// data是迭代中的数组.
///
/// 这个数组中,只有data[alive]是有效的,访问其他的部分,即data[..alive.start]
/// 及data[end..]会发生UB
///
data: [MaybeUninit<T>; N],
/// 表明数组中有效的范围.
///
/// 必须满足:
/// - `alive.start <= alive.end`
/// - `alive.end <= N`
alive: Range<usize>,
}
从后继的代码可以看出,一旦使用了Iterator, 数组便被IntoIter所代替。
impl<T, const N: usize> IntoIter<T, N> {
pub fn new(array: [T; N]) -> Self {
//
// 因为RUST特性目前还不支持数组的transmute,所以用了内存跨类型的transmute_copy,此函数将从栈中申请一块内存。
// 拷贝完毕后,原数组的所有权已经转移到data中,且data也完成了初始化。此时,需要调用mem::forget反应所有权已经失去。
// mem::forget不会导致内存泄漏。
unsafe {
let iter = Self { data: mem::transmute_copy(&array), alive: 0..N };
mem::forget(array);
iter
}
}
pub fn as_slice(&self) -> &[T] {
// SAFETY: We know that all elements within `alive` are properly initialized.
unsafe {
//此处调用SliceIndex::<Range>::get_unchecked
let slice = self.data.get_unchecked(self.alive.clone());
MaybeUninit::slice_assume_init_ref(slice)
}
}
pub fn as_mut_slice(&mut self) -> &mut [T] {
unsafe {
//此处调用SliceIndex::<Range>::get_unchecked_mut
let slice = self.data.get_unchecked_mut(self.alive.clone());
MaybeUninit::slice_assume_init_mut(slice)
}
}
}
impl<T, const N: usize> Iterator for IntoIter<T, N> {
type Item = T;
fn next(&mut self) -> Option<Self::Item> {
// 下面使用Range的Iterator特性实现next. alive的start会变化,从而导致start之前的数组元素无法再被访问。
// Option::map完成下标值传递。
self.alive.next().map(|idx| {
// SliceIndex::<usize>::get_unchecked, MaybeUninit::<T>::assume_init_read()
// 前面有过说明,assume_init_read()从堆栈中申请了T大小的内存,然后进行内存拷贝,然后返回变量
// 此时array元素的所有权转移到返回值。
unsafe { self.data.get_unchecked(idx).assume_init_read() }
})
}
...
...
}
impl<T, const N: usize> Drop for IntoIter<T, N> {
// 因为IntoIter使用的内存是调用MaybeUninit::uninit()从栈中获得的, 感觉不释放似乎也没有内存泄漏问题。
// 此处的必要性还需要再思考。
fn drop(&mut self) {
// as_mut_slice()获得所有具有所有权的元素,这些元素需要调用drop来释放。这里,data变量中的元素始终封装在MaybeUninit
unsafe { ptr::drop_in_place(self.as_mut_slice()) }
}
}
以上需要特别注意所有权的转移和内存drop调用,这是RUST需要特别注意训练的点。
impl<T, const N: usize> IntoIterator for [T; N] {
type Item = T;
type IntoIter = IntoIter<T, N>;
/// Creates a consuming iterator, that is, one that moves each value out of
/// the array (from start to end). The array cannot be used after calling
/// this unless `T` implements `Copy`, so the whole array is copied.
/// 创建消费型的iterator, 如果T不实现`Copy`, 则调用此函数后,数组不可再被访问。
fn into_iter(self) -> Self::IntoIter {
IntoIter::new(self)
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<'a, T, const N: usize> IntoIterator for &'a [T; N] {
type Item = &'a T;
type IntoIter = Iter<'a, T>;
//调用了slice::iter(), &[T;N]实质是slice结构[T]
fn into_iter(self) -> Iter<'a, T> {
self.iter()
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<'a, T, const N: usize> IntoIterator for &'a mut [T; N] {
type Item = &'a mut T;
type IntoIter = IterMut<'a, T>;
//同上
fn into_iter(self) -> IterMut<'a, T> {
self.iter_mut()
}
}
对于数组类型,iterator的实现耗费了大量的资源并有很多内存操作。对于数组,尽可能的使用引用的Iterator。
切片排序
/// 插入排序, 复杂度O(n^2).
fn insertion_sort<T, F>(v: &mut [T], is_less: &mut F)
where
F: FnMut(&T, &T) -> bool,
{
//排序场景下,基本不能使用iterator
for i in 1..v.len() {
shift_tail(&mut v[..i + 1], is_less);
}
}
/// 将最后的值左移到遇到更小的值.
fn shift_tail<T, F>(v: &mut [T], is_less: &mut F)
where
F: FnMut(&T, &T) -> bool,
{
let len = v.len();
// 因为是对泛型排序,RUST的排序算法比较复杂, 需要指出,&mut [T] 保证了外界不会有对数组或数组元素的引用,而数组元素本身的内存
// 浅拷贝等同于所有权转移,不会出现内存安全问题。
unsafe {
if len >= 2 && is_less(v.get_unchecked(len - 1), v.get_unchecked(len - 2)) {
// ManuallyDrop把drop的权利从rust编译器接管
let mut tmp = mem::ManuallyDrop::new(ptr::read(v.get_unchecked(len - 1)));
// CopyOnDrop会在drop的时候做src到dest的拷贝
let mut hole = CopyOnDrop { src: &mut *tmp, dest: v.get_unchecked_mut(len - 2) };
ptr::copy_nonoverlapping(v.get_unchecked(len - 2), v.get_unchecked_mut(len - 1), 1);
//正常的排序内存置换操作
for i in (0..len - 2).rev() {
if !is_less(&*tmp, v.get_unchecked(i)) {
break;
}
ptr::copy_nonoverlapping(v.get_unchecked(i), v.get_unchecked_mut(i + 1), 1);
hole.dest = v.get_unchecked_mut(i);
}
}
}
}
由上可见,即使是简单的排序算法,也必须使用mem及ptr和unsafe代码。而排序实际上是最基本的编程,因此若果ptr和mem模块是必须深刻理解的。