Struct KOnceCellGuard 

pub struct KOnceCellGuard<'a, T, Class> { /* private fields */ }

A safe RAII / proxy guard providing synchronized access to a KOnceCell protected by a lock.

Created by calling guard.field_cell() on a lock guard generated by #[ksync::guarded], or via KOnceCell::guard.

Implementations

impl<'a, T, Class> KOnceCellGuard<'a, T, Class>

pub unsafe fn new( cell: &'a KOnceCell<T, Class>, _token: &'a mut LockToken<'_, Class>, ) -> Self

Creates a new KOnceCellGuard from a cell reference and an exclusive lock token.

Safety

The caller must guarantee that the provided LockToken belongs to the specific lock instance that guards this KOnceCell (rather than a different lock of the same lock class Class).

pub fn is_initialized(&self) -> bool

Returns true if the cell has been initialized.

pub fn get(&self) -> Option<&T>

Returns a reference to the initialized value, or None if uninitialized.

pub fn get_mut(&mut self) -> Option<&mut T>

Returns a mutable reference to the initialized value, or None if uninitialized.

pub fn set(&mut self, value: T) -> Result<(), T>

Sets the value of the cell if uninitialized, returning Err(value) if already initialized.

pub fn get_or_init(&mut self, f: impl FnOnce() -> T) -> &mut T

Initializes the cell with the given closure if uninitialized, returning a mutable reference to the contained value.

pub fn get_or_try_init<E>( &mut self, f: impl FnOnce() -> Result<T, E>, ) -> Result<&mut T, E>

Initializes the cell with the given fallible closure if uninitialized, returning a mutable reference to the contained value or the error.

pub fn get_or_pin_init<E>( &mut self, init: impl PinInit<T, E>, ) -> Result<&mut T, E>

Initializes the cell in-place with PinInit if uninitialized, returning a mutable reference to the contained value or the initialization error.

Trait Implementations

impl<T: Debug, Class> Debug for KOnceCellGuard<'_, T, Class>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.