]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
rust: str: improve safety comment for CString::try_from_fmt
authorNakamura Shuta <nakamura.shuta@gmail.com>
Mon, 19 Jan 2026 06:29:25 +0000 (15:29 +0900)
committerMiguel Ojeda <ojeda@kernel.org>
Sun, 22 Mar 2026 23:08:55 +0000 (00:08 +0100)
commitbf074eb6891be799174ff42e0051492681fdc045
tree66eac145ae63f9536613c6babc1dd916d4b31940
parent79e25710e7227228902d672417b552dd1d7e5d3b
rust: str: improve safety comment for CString::try_from_fmt

Improve the safety comment for the `inc_len()` call in
`CString::try_from_fmt()` to clarify why `bytes_written()` is
guaranteed not to exceed the buffer capacity.

The current comment states that bytes written is bounded by size,
but does not explain that this invariant is maintained because:
1. The `Formatter` is created with `size` as its capacity limit
2. The `?` operators on `write_fmt` and `write_str` ensure early
   return if writing exceeds this limit

Suggested-by: Gary Guo <gary@garyguo.net>
Link: https://lore.kernel.org/rust-for-linux/20221114145329.0f47a3ab@GaryWorkstation/
Link: https://github.com/Rust-for-Linux/linux/issues/936
Signed-off-by: Nakamura Shuta <nakamura.shuta@gmail.com>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Link: https://patch.msgid.link/20260119062925.1647-1-nakamura.shuta@gmail.com
[ Updated tags: it was a suggestion from Gary from the mailing list
  (the linked issue is mostly about adding a `debug_assert_eq!`).
    - Miguel ]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
rust/kernel/str.rs