Struct kernel::types::Opaque

#[repr(transparent)]
pub struct Opaque<T> { /* private fields */ }

Stores an opaque value.

This is meant to be used with FFI objects that are never interpreted by Rust code.

Implementations

impl<T> Opaque<T>

pub const fn new(value: T) -> Self

Creates a new opaque value.

pub const fn uninit() -> Self

Creates an uninitialised value.

pub fn ffi_init(init_func: impl FnOnce(*mut T)) -> impl PinInit<Self>

Creates a pin-initializer from the given initializer closure.

The returned initializer calls the given closure with the pointer to the inner T of this Opaque. Since this memory is uninitialized, the closure is not allowed to read from it.

This function is safe, because the T inside of an Opaque is allowed to be uninitialized. Additionally, access to the inner T requires unsafe, so the caller needs to verify at that point that the inner value is valid.

pub fn get(&self) -> *mut T

Returns a raw pointer to the opaque data.

pub const fn raw_get(this: *const Self) -> *mut T

Gets the value behind this.

This function is useful to get access to the value without creating intermediate references.

Trait Implementations

impl<T> Zeroable for Opaque<T>