From: Peder Bergan 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 --- 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