]> www.infradead.org Git - users/hch/misc.git/commit
rust: types: improve `ForeignOwnable` documentation
authorBenno Lossin <benno.lossin@proton.me>
Tue, 30 Jul 2024 18:23:04 +0000 (18:23 +0000)
committerMiguel Ojeda <ojeda@kernel.org>
Sun, 18 Aug 2024 21:10:53 +0000 (23:10 +0200)
commit7adcdd572248591c3932e27d98b4a086662d5cbe
tree10d251f98c7c4514729bcb0e796c6addcafee712
parent6c2d0ad53b8ff25cb1a12570191576d834e9108d
rust: types: improve `ForeignOwnable` documentation

There are no guarantees for the pointer returned by `into_foreign`.
This is simply because there is no safety documentation stating any
guarantees. Therefore dereferencing and all other operations for that
pointer are not allowed in a general context (i.e. when the concrete
type implementing the trait is not known).
This might be confusing, therefore add normal documentation to state
that there are no guarantees given for the pointer.

Signed-off-by: Benno Lossin <benno.lossin@proton.me>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Link: https://lore.kernel.org/r/20240730182251.1466684-1-benno.lossin@proton.me
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
rust/kernel/types.rs