Re: [PATCH 05/13] rust: str: use `NUL` instead of 0 in doc comments

From: Trevor Gross
Date: Wed Jan 17 2024 - 19:39:25 EST


On Tue, Jan 16, 2024 at 5:36 PM Valentin Obst <kernel@xxxxxxxxxxxxxxx> wrote:
>
> Throughout the module, bytes with the value zero are referred to as
> `NUL` bytes. Adapt the only two outliers.
>
> Signed-off-by: Valentin Obst <kernel@xxxxxxxxxxxxxxx>
> ---
> rust/kernel/str.rs | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs
> index 0a8569594fc3..843ffeec9b3e 100644
> --- a/rust/kernel/str.rs
> +++ b/rust/kernel/str.rs
> @@ -149,13 +149,13 @@ pub const fn as_char_ptr(&self) -> *const core::ffi::c_char {
> self.0.as_ptr() as _
> }
>
> - /// Convert the string to a byte slice without the trailing 0 byte.
> + /// Convert the string to a byte slice without the trailing `NUL` byte.
> #[inline]
> pub fn as_bytes(&self) -> &[u8] {
> &self.0[..self.len()]
> }
>
> - /// Convert the string to a byte slice containing the trailing 0 byte.
> + /// Convert the string to a byte slice containing the trailing `NUL` byte.
> #[inline]
> pub const fn as_bytes_with_nul(&self) -> &[u8] {
> &self.0
> --
> 2.43.0
>
>

Reviewed-by: Trevor Gross <tmgross@xxxxxxxxx>