[PATCH v3 2/2] rust: alloc: kvec: add doc example for `as_slice` method
From: Hui Zhu
Date: Thu Jul 24 2025 - 03:55:57 EST
From: Hui Zhu <zhuhui@xxxxxxxxxx>
Add a practical usage example to the documentation of `KVec::as_slice()`
showing how to:
Create a new `KVec`
Push elements into it
Convert to a slice via `as_slice()`
Co-developed-by: Geliang Tang <geliang@xxxxxxxxxx>
Signed-off-by: Geliang Tang <geliang@xxxxxxxxxx>
Signed-off-by: Hui Zhu <zhuhui@xxxxxxxxxx>
---
rust/kernel/alloc/kvec.rs | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/rust/kernel/alloc/kvec.rs b/rust/kernel/alloc/kvec.rs
index 3c72e0bdddb8..d384c34d1a5e 100644
--- a/rust/kernel/alloc/kvec.rs
+++ b/rust/kernel/alloc/kvec.rs
@@ -224,6 +224,15 @@ unsafe fn dec_len(&mut self, count: usize) -> &mut [T] {
}
/// Returns a slice of the entire vector.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// let mut v = KVec::new();
+ /// v.push(1, GFP_KERNEL);
+ /// v.push(2, GFP_KERNEL);
+ /// assert_eq!(v.as_slice(), &[1, 2]);
+ /// ```
#[inline]
pub fn as_slice(&self) -> &[T] {
self
--
2.43.0