Re: [PATCH v2 20/21] rust: allow extracting the buffer from a CString

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 2 potential issue(s) to consider:
- [Medium] The `into_vec` method diverges from Rust's standard library `CString` naming conventions, obscuring the presence of the NUL terminator and creating a dangerous API trap.
- [Low] Typo in the commit message: 'aroud' instead of 'around'.
--

commit a1ef2ecd44b6df9c9b3d012bdcb8952ab17a0f53
Author: Alistair Francis <alistair@alistair23.me>

rust: allow extracting the buffer from a CString

This patch introduces a method to consume a CString and return its
underlying KVec buffer. It allows users to create a CString and then
extract the internal byte vector for further use.

> The kernel CString is a wrapper aroud a KVec. This patch allows

[Severity: Low]
This isn't a bug, but there is a typo in the commit message: "aroud"
should be "around".

> diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs
> --- a/rust/kernel/str.rs
> +++ b/rust/kernel/str.rs
> @@ -870,6 +870,12 @@ pub fn try_from_fmt(args: fmt::Arguments<'_>) -> Result<Self, Error> {
>          // exist in the buffer.
>          Ok(Self { buf })
>      }
> +
> +    /// Return the internal buffer while consuming the original [`CString`]
> +    #[inline]
> +    pub fn into_vec(self) -> KVec<u8> {
> +        self.buf
> +    }

[Severity: Medium]
Does this naming diverge from standard Rust library conventions and obscure
the presence of the NUL terminator?

In the standard library, extracting the underlying buffer from a CString
typically strips the NUL byte with a method like into_bytes(), while the
method that keeps it is explicitly named into_bytes_with_nul(). 

Calling this into_vec() might mislead callers into assuming the NUL byte is
already stripped, which could cause developers to unintentionally include a
NUL byte in buffers or calculate incorrect offsets.

Could this be renamed to into_bytes_with_nul() to match standard
conventions and clarify the buffer's contents?

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260623045406.2589547-1-alistair.francis@wdc.com?part=20