pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized {
// Required method
unsafe fn __pinned_init(self, slot: *mut T) -> Result<(), E>;
// Provided method
fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
where F: FnOnce(Pin<&mut T>) -> Result<(), E> { ... }
}Expand description
A pin-initializer for the type T.
To use this initializer, you will need a suitable memory location that can hold a T. This can
be Box<T>, Arc<T> or even the stack (see stack_pin_init!).
Also see the module description.
§Safety
When implementing this trait you will need to take great care. Also there are probably very few
cases where a manual implementation is necessary. Use pin_init_from_closure where possible.
The PinInit::__pinned_init function:
- returns
Ok(())if it initialized every field ofslot, - returns
Err(err)if it encountered an error and then cleanedslot, this means:slotcan be deallocated without UB occurring,slotdoes not need to be dropped,slotis not partially initialized.
- while constructing the
Tatslotit upholds the pinning invariants ofT.
Required Methods§
Provided Methods§
Sourcefn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>
First initializes the value using self then calls the function f with the initialized
value.
If f returns an error the value is dropped and the initializer will forward the error.
§Examples
let mtx_init = CMutex::new(42);
// Make the initializer print the value.
let mtx_init = mtx_init.pin_chain(|mtx| {
println!("{:?}", mtx.get_data_mut());
Ok(())
});Dyn Compatibility§
This trait is not dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.