Commit 8cfce47d authored by Valentin Obst's avatar Valentin Obst Committed by Miguel Ojeda
Browse files

rust: str: use `NUL` instead of 0 in doc comments 



Throughout the module, bytes with the value zero are referred to as
`NUL` bytes. Adapt the only two outliers.

Signed-off-by: default avatarValentin Obst <kernel@valentinobst.de>
Reviewed-by: default avatarTrevor Gross <tmgross@umich.edu>
Reviewed-by: default avatarMartin Rodriguez Reboredo <yakoyoku@gmail.com>
Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Link: https://lore.kernel.org/r/20240131-doc-fixes-v3-v3-5-0c8af94ed7de@valentinobst.de


Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent ed859653

rust/kernel/str.rs

+2 −2
Original line number Diff line number Diff line
@@ -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