mirror of
https://gitee.com/bianbu-linux/linux-6.6
synced 2025-04-24 14:07:52 -04:00
rust: types: add Opaque::ffi_init
This function allows to easily initialize `Opaque` with the pin-init API. `Opaque::ffi_init` takes a closure and returns a pin-initializer. This pin-initiailizer calls the given closure with a pointer to the inner `T`. Co-developed-by: Gary Guo <gary@garyguo.net> Signed-off-by: Gary Guo <gary@garyguo.net> Signed-off-by: Benno Lossin <benno.lossin@proton.me> Reviewed-by: Andreas Hindborg <a.hindborg@samsung.com> Reviewed-by: Alice Ryhl <aliceryhl@google.com> Link: https://lore.kernel.org/r/20230408122429.1103522-14-y86-dev@protonmail.com [ Fixed typo. ] Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
This commit is contained in:
parent
8586f1acd3
commit
692e8935e2
2 changed files with 29 additions and 0 deletions
|
@ -177,6 +177,14 @@
|
|||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! For the special case where initializing a field is a single FFI-function call that cannot fail,
|
||||
//! there exist the helper function [`Opaque::ffi_init`]. This function initialize a single
|
||||
//! [`Opaque`] field by just delegating to the supplied closure. You can use these in combination
|
||||
//! with [`pin_init!`].
|
||||
//!
|
||||
//! For more information on how to use [`pin_init_from_closure()`], take a look at the uses inside
|
||||
//! the `kernel` crate. The [`sync`] module is a good starting point.
|
||||
//!
|
||||
//! [`sync`]: kernel::sync
|
||||
//! [pinning]: https://doc.rust-lang.org/std/pin/index.html
|
||||
//! [structurally pinned fields]:
|
||||
|
@ -187,6 +195,7 @@
|
|||
//! [`impl PinInit<T, E>`]: PinInit
|
||||
//! [`impl Init<T, E>`]: Init
|
||||
//! [`Opaque`]: kernel::types::Opaque
|
||||
//! [`Opaque::ffi_init`]: kernel::types::Opaque::ffi_init
|
||||
//! [`pin_data`]: ::macros::pin_data
|
||||
|
||||
use crate::{
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue