Commit 4c62348d authored by Valentin Obst's avatar Valentin Obst Committed by Miguel Ojeda
Browse files

rust: str: move SAFETY comment in front of unsafe block 



SAFETY comments should immediately precede the unsafe block they
justify. Move assignment to `bar` past comment as it is safe.

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-6-0c8af94ed7de@valentinobst.de


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

rust/kernel/str.rs

+1 −1
Original line number Diff line number Diff line
@@ -191,9 +191,9 @@ pub fn to_str(&self) -> Result<&str, core::str::Utf8Error> { 
    /// ```

    /// # use kernel::c_str;

    /// # use kernel::str::CStr;

    /// let bar = c_str!("ツ");

    /// // SAFETY: String literals are guaranteed to be valid UTF-8

    /// // by the Rust compiler.

    /// let bar = c_str!("ツ");

    /// assert_eq!(unsafe { bar.as_str_unchecked() }, "ツ");

    /// ```

    #[inline]