From: Peder Bergan via B4 Relay <devnull+peder.bergan.gmail.com@kernel.org>
To: Miguel Ojeda <ojeda@kernel.org>
Cc: "Boqun Feng" <boqun@kernel.org>, "Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <lossin@kernel.org>,
"Andreas Hindborg" <a.hindborg@kernel.org>,
"Alice Ryhl" <aliceryhl@google.com>,
"Trevor Gross" <tmgross@umich.edu>,
"Danilo Krummrich" <dakr@kernel.org>,
"Daniel Almeida" <daniel.almeida@collabora.com>,
"Tamir Duberstein" <tamird@kernel.org>,
"Alexandre Courbot" <acourbot@nvidia.com>,
"Onur Özkan" <work@onurozkan.dev>,
rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
stable@vger.kernel.org,
"Georgios Androutsopoulos" <georgeandrout13@gmail.com>
Subject: [PATCH v2 2/2] rust: str: add an example for Formatter::new
Date: Tue, 17 Nov 2026 18:57:07 +0100 [thread overview]
Message-ID: <20261117-formatter-lifetime-v2-2-e216d86ffb57@gmail.com> (raw)
In-Reply-To: <20261117-formatter-lifetime-v2-0-e216d86ffb57@gmail.com>
From: Peder Bergan <peder.bergan@gmail.com>
Document the exclusive buffer borrow held by Formatter::new() and show
formatting into a live buffer. Check the number of bytes written and the
resulting buffer contents.
Signed-off-by: Peder Bergan <peder.bergan@gmail.com>
---
rust/kernel/str.rs | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/rust/kernel/str.rs b/rust/kernel/str.rs
index e5fe84eeb..6222faacf 100644
--- a/rust/kernel/str.rs
+++ b/rust/kernel/str.rs
@@ -658,6 +658,22 @@ impl<'a> Formatter<'a> {
}
/// Create a new [`Self`] instance.
+ ///
+ /// The formatter exclusively borrows `buffer` for its lifetime.
+ ///
+ /// # Examples
+ ///
+ /// ```
+ /// use kernel::fmt::Write as _;
+ /// use kernel::str::Formatter;
+ ///
+ /// let mut buffer = [0; 4];
+ /// let mut formatter = Formatter::new(&mut buffer);
+ /// formatter.write_str("test")?;
+ /// assert_eq!(formatter.bytes_written(), 4);
+ /// assert_eq!(&buffer, b"test");
+ /// # Ok::<(), kernel::error::Error>(())
+ /// ```
pub fn new(buffer: &'a mut [u8]) -> Self {
// SAFETY: `buffer` is valid for writes for the entire length for
// the lifetime of `Self`.
--
2.56.1
prev parent reply other threads:[~2026-11-17 17:57 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-17 17:57 [PATCH v2 0/2] rust: str: tie Formatter to its backing buffer Peder Bergan via B4 Relay
2026-11-17 17:57 ` [PATCH v2 1/2] " Peder Bergan via B4 Relay
2026-11-17 17:57 ` Peder Bergan via B4 Relay [this message]
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=20261117-formatter-lifetime-v2-2-e216d86ffb57@gmail.com \
--to=devnull+peder.bergan.gmail.com@kernel.org \
--cc=a.hindborg@kernel.org \
--cc=acourbot@nvidia.com \
--cc=aliceryhl@google.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun@kernel.org \
--cc=dakr@kernel.org \
--cc=daniel.almeida@collabora.com \
--cc=gary@garyguo.net \
--cc=georgeandrout13@gmail.com \
--cc=linux-kernel@vger.kernel.org \
--cc=lossin@kernel.org \
--cc=ojeda@kernel.org \
--cc=peder.bergan@gmail.com \
--cc=rust-for-linux@vger.kernel.org \
--cc=stable@vger.kernel.org \
--cc=tamird@kernel.org \
--cc=tmgross@umich.edu \
--cc=work@onurozkan.dev \
/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
all inboxes | Powered by JetHome®