rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Andreas Hindborg <a.hindborg@kernel.org>
To: "Boqun Feng" <boqun.feng@gmail.com>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Alex Gaynor" <alex.gaynor@gmail.com>,
	"Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <lossin@kernel.org>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Trevor Gross" <tmgross@umich.edu>,
	"Danilo Krummrich" <dakr@kernel.org>,
	"Jens Axboe" <axboe@kernel.dk>,
	"Breno Leitao" <leitao@debian.org>
Cc: linux-block@vger.kernel.org, rust-for-linux@vger.kernel.org,
	 linux-kernel@vger.kernel.org,
	Andreas Hindborg <a.hindborg@kernel.org>
Subject: [PATCH v5 02/18] rust: str: allow `str::Formatter` to format into `&mut [u8]`.
Date: Fri, 15 Aug 2025 09:30:37 +0200	[thread overview]
Message-ID: <20250815-rnull-up-v6-16-v5-2-581453124c15@kernel.org> (raw)
In-Reply-To: <20250815-rnull-up-v6-16-v5-0-581453124c15@kernel.org>

Improve `Formatter` so that it can write to an array or slice buffer.

Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Signed-off-by: Andreas Hindborg <a.hindborg@kernel.org>
---
 rust/kernel/str.rs | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs
index 082790b7a621..76632da357a6 100644
--- a/rust/kernel/str.rs
+++ b/rust/kernel/str.rs
@@ -7,7 +7,10 @@
     fmt::{self, Write},
     prelude::*,
 };
-use core::ops::{self, Deref, DerefMut, Index};
+use core::{
+    marker::PhantomData,
+    ops::{self, Deref, DerefMut, Index},
+};
 
 /// Byte string without UTF-8 validity guarantee.
 #[repr(transparent)]
@@ -825,9 +828,9 @@ fn write_str(&mut self, s: &str) -> fmt::Result {
 /// Allows formatting of [`fmt::Arguments`] into a raw buffer.
 ///
 /// Fails if callers attempt to write more than will fit in the buffer.
-pub(crate) struct Formatter(RawFormatter);
+pub(crate) struct Formatter<'a>(RawFormatter, PhantomData<&'a mut ()>);
 
-impl Formatter {
+impl Formatter<'_> {
     /// Creates a new instance of [`Formatter`] with the given buffer.
     ///
     /// # Safety
@@ -836,11 +839,19 @@ impl Formatter {
     /// for the lifetime of the returned [`Formatter`].
     pub(crate) unsafe fn from_buffer(buf: *mut u8, len: usize) -> Self {
         // SAFETY: The safety requirements of this function satisfy those of the callee.
-        Self(unsafe { RawFormatter::from_buffer(buf, len) })
+        Self(unsafe { RawFormatter::from_buffer(buf, len) }, PhantomData)
+    }
+
+    /// Create a new [`Self`] instance.
+    #[expect(dead_code)]
+    pub(crate) fn new(buffer: &mut [u8]) -> Self {
+        // SAFETY: `buffer` is valid for writes for the entire length for
+        // the lifetime of `Self`.
+        unsafe { Formatter::from_buffer(buffer.as_mut_ptr(), buffer.len()) }
     }
 }
 
-impl Deref for Formatter {
+impl Deref for Formatter<'_> {
     type Target = RawFormatter;
 
     fn deref(&self) -> &Self::Target {
@@ -848,7 +859,7 @@ fn deref(&self) -> &Self::Target {
     }
 }
 
-impl fmt::Write for Formatter {
+impl fmt::Write for Formatter<'_> {
     fn write_str(&mut self, s: &str) -> fmt::Result {
         self.0.write_str(s)?;
 

-- 
2.47.2



  parent reply	other threads:[~2025-08-15  7:32 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-08-15  7:30 [PATCH v5 00/18] rnull: add configfs, remote completion to rnull Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 01/18] rust: str: normalize imports in `str.rs` Andreas Hindborg
2025-08-15  7:30 ` Andreas Hindborg [this message]
2025-08-27 12:48   ` [PATCH v5 02/18] rust: str: allow `str::Formatter` to format into `&mut [u8]` Daniel Almeida
2025-08-29 11:18     ` Andreas Hindborg
2025-08-29 18:27       ` Konstantin Ryabitsev
2025-09-01  7:58         ` Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 03/18] rust: str: expose `str::{Formatter, RawFormatter}` publicly Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 04/18] rust: str: introduce `NullTerminatedFormatter` Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 05/18] rust: str: introduce `kstrtobool` function Andreas Hindborg
2025-08-15  7:57   ` Alice Ryhl
2025-08-15  8:21     ` Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 06/18] rust: str: add `bytes_to_bool` helper function Andreas Hindborg
2025-08-15  8:12   ` Alice Ryhl
2025-08-15  8:28     ` Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 07/18] rust: configfs: re-export `configfs_attrs` from `configfs` module Andreas Hindborg
2025-08-15  8:13   ` Alice Ryhl
2025-08-15  8:29     ` Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 08/18] rust: block: normalize imports for `gen_disk.rs` Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 09/18] rust: block: use `NullTerminatedFormatter` Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 10/18] rust: block: remove `RawWriter` Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 11/18] rust: block: remove trait bound from `mq::Request` definition Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 12/18] rust: block: add block related constants Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 13/18] rnull: move driver to separate directory Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 14/18] rnull: enable configuration via `configfs` Andreas Hindborg
2025-08-15  8:17   ` Alice Ryhl
2025-08-15  9:04     ` Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 15/18] rust: block: add `GenDisk` private data support Andreas Hindborg
2025-08-15  8:18   ` Alice Ryhl
2025-08-15  9:08     ` Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 16/18] rust: block: mq: fix spelling in a safety comment Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 17/18] rust: block: add remote completion to `Request` Andreas Hindborg
2025-08-15  7:30 ` [PATCH v5 18/18] rnull: add soft-irq completion support Andreas Hindborg
2025-08-15  8:21   ` Alice Ryhl

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250815-rnull-up-v6-16-v5-2-581453124c15@kernel.org \
    --to=a.hindborg@kernel.org \
    --cc=alex.gaynor@gmail.com \
    --cc=aliceryhl@google.com \
    --cc=axboe@kernel.dk \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=dakr@kernel.org \
    --cc=gary@garyguo.net \
    --cc=leitao@debian.org \
    --cc=linux-block@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lossin@kernel.org \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=tmgross@umich.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).