Commit 3ac88a99 authored Feb 24, 2026 by Alexandre Courbot Committed by Miguel Ojeda Mar 04, 2026

rust: str: make NullTerminatedFormatter public



If `CONFIG_BLOCK` is disabled, the following warnings are displayed
during build:

  warning: struct `NullTerminatedFormatter` is never constructed
    --> ../rust/kernel/str.rs:667:19
      |
  667 | pub(crate) struct NullTerminatedFormatter<'a> {
      |                   ^^^^^^^^^^^^^^^^^^^^^^^
      |
      = note: `#[warn(dead_code)]` (part of `#[warn(unused)]`) on by default

  warning: associated function `new` is never used
    --> ../rust/kernel/str.rs:673:19
      |
  671 | impl<'a> NullTerminatedFormatter<'a> {
      | ------------------------------------ associated function in this implementation
  672 |     /// Create a new [`Self`] instance.
  673 |     pub(crate) fn new(buffer: &'a mut [u8]) -> Option<NullTerminatedFormatter<'a>> {

Fix them by making `NullTerminatedFormatter` public, as it could be
useful for drivers anyway.

Fixes: cdde7a19 ("rust: str: introduce `NullTerminatedFormatter`")
Signed-off-by: Alexandre Courbot <acourbot@nvidia.com>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Reviewed-by: Andreas Hindborg <a.hindborg@kernel.org>
Cc: stable@vger.kernel.org
Link: https://patch.msgid.link/20260224-nullterminatedformatter-v1-1-5bef7b9b3d4c@nvidia.com


Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

parent 11439c46

rust/kernel/str.rs

+2 −2

Original line number	Diff line number	Diff line
		@@ -664,13 +664,13 @@ fn write_str(&mut self, s: &str) -> fmt::Result {
		///
		/// * The first byte of `buffer` is always zero.
		/// * The length of `buffer` is at least 1.
		pub(crate) struct NullTerminatedFormatter<'a> {
		pub struct NullTerminatedFormatter<'a> {
		buffer: &'a mut [u8],
		}

		impl<'a> NullTerminatedFormatter<'a> {
		/// Create a new [`Self`] instance.
		pub(crate) fn new(buffer: &'a mut [u8]) -> Option<NullTerminatedFormatter<'a>> {
		pub fn new(buffer: &'a mut [u8]) -> Option<NullTerminatedFormatter<'a>> {
		*(buffer.first_mut()?) = 0;

		// INVARIANT: