结构体 ReadBuf 

pub struct ReadBuf<'a> { /* 私有字段 */ }

一个字节缓冲区的包装器，可增量填充和初始化。

此类型是一种“双游标”。它跟踪缓冲区中的三个区域：缓冲区开头已逻辑填充数据的区域、已在某个时刻初始化但尚未逻辑填充的区域，以及末尾可能未初始化的区域。填充区域保证是初始化区域的子集。

总之，缓冲区的内容可以可视化为：

[             capacity              ]
[ filled |         unfilled         ]
[    initialized    | uninitialized ]

从未初始化区域取消初始化任何字节属于未定义行为，因为这仅仅是未知此区域是否未初始化，并且如果其一部分实际上是已初始化的，则它必须保持已初始化。

实现

impl<'a> ReadBuf<'a>

pub fn new(buf: &'a mut [u8]) -> ReadBuf<'a>

从完全初始化的缓冲区创建一个新的 ReadBuf。

pub fn uninit(buf: &'a mut [MaybeUninit<u8>]) -> ReadBuf<'a>

从可能未初始化的缓冲区创建一个新的 ReadBuf。

内部游标会将整个缓冲区标记为未初始化。如果已知缓冲区已部分初始化，则使用 assume_init 移动内部游标。

pub fn capacity(&self) -> usize

返回缓冲区的总容量。

pub fn filled(&self) -> &[u8]

返回对缓冲区已填充部分的共享引用。

pub fn filled_mut(&mut self) -> &mut [u8]

返回对缓冲区已填充部分的可变引用。

pub fn take(&mut self, n: usize) -> ReadBuf<'_>

返回一个新的 ReadBuf，由最多 n 的未填充部分组成。

pub fn initialized(&self) -> &[u8]

返回对缓冲区已初始化部分的共享引用。

这包括已填充的部分。

pub fn initialized_mut(&mut self) -> &mut [u8]

返回对缓冲区已初始化部分的可变引用。

这包括已填充的部分。

pub unsafe fn inner_mut(&mut self) -> &mut [MaybeUninit<u8>]

返回对整个缓冲区的可变引用，而不确保它已完全初始化。

0 到 self.filled().len() 之间的元素是已填充的，而 0 到 self.initialized().len() 之间的元素是已初始化的（因此可以转换为 &mut [u8]）。

此方法的调用者必须确保这些不变量得到遵守。例如，如果调用者初始化了缓冲区未初始化部分的某些内容，则必须使用已初始化的字节数调用 assume_init。

安全性

调用者不得反初始化缓冲区中已经初始化的部分。这包括 ReadBuf 标记为未初始化的区域中的任何字节。

pub unsafe fn unfilled_mut(&mut self) -> &mut [MaybeUninit<u8>]

返回对缓冲区未填充部分的可变引用，而不确保它已完全初始化。

安全性

调用者不得反初始化缓冲区中已经初始化的部分。这包括 ReadBuf 标记为未初始化的区域中的任何字节。

pub fn initialize_unfilled(&mut self) -> &mut [u8]

返回对缓冲区未填充部分的可变引用，确保它已完全初始化。

由于 ReadBuf 跟踪缓冲区中已初始化的区域，因此在首次使用之后，这实际上是“免费”的。

pub fn initialize_unfilled_to(&mut self, n: usize) -> &mut [u8]

返回对缓冲区未填充部分前 n 个字节的可变引用，确保它已完全初始化。

恐慌

如果 self.remaining() 小于 n，则会发生 panic。

pub fn remaining(&self) -> usize

返回切片末尾尚未填充的字节数。

pub fn clear(&mut self)

清空缓冲区，将填充区域重置为空。

已初始化的字节数不变，缓冲区的内容也不会被修改。

pub fn advance(&mut self, n: usize)

推进缓冲区填充区域的大小。

已初始化的字节数不会改变。

恐慌

如果缓冲区的填充区域变得大于初始化区域，则会发生 panic。

pub fn set_filled(&mut self, n: usize)

设置缓冲区填充区域的大小。

已初始化的字节数不会改变。

请注意，除了可以扩大缓冲区填充区域之外，这还可用于缩小它（例如，由就地压缩数据的 AsyncRead 实现使用）。

恐慌

如果缓冲区的填充区域变得大于初始化区域，则会发生 panic。

pub unsafe fn assume_init(&mut self, n: usize)

断言缓冲区的前 n 个未填充字节已初始化。

ReadBuf 假定字节永远不会被取消初始化，因此当使用少于已知已初始化的字节数调用此方法时，它不会执行任何操作。

安全性

调用者必须确保缓冲区的 n 个未填充字节已初始化。

pub fn put_slice(&mut self, buf: &[u8])

将数据追加到缓冲区，推进写入位置，可能也会推进初始化位置。

恐慌

如果 self.remaining() 小于 buf.len()，则会发生 panic。

trait 实现

impl Debug for ReadBuf<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

使用给定的格式化器格式化此值。 更多信息