Struct KCell 

pub struct KCell<T, Class> { /* private fields */ }

A container cell that safe-guards data of type T using type-level lock class tracking.

KCell holds data that can only be safely accessed (read or written) by proving that the corresponding mutual exclusion lock of class Class is currently held by the current thread via a LockToken.

Implementations

impl<T, Class> KCell<T, Class>

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

Creates a new KCell containing the specified value.

pub unsafe fn get<'b, Token, Idx>(&self, _token: &'b Token) -> &'b T

where Token: LockTokenRead<Class, Idx>,

Access the guarded value immutably using a shared lock token.

Safety

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

pub unsafe fn get_mut<'b, Token, Idx>(&self, _token: &'b mut Token) -> &'b mut T

where Token: LockTokenWrite<Class, Idx>,

Access the guarded value mutably using a mutable lock token.

Safety

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

pub unsafe fn get_pinned_mut_locked<'b, Token, Idx>( &self, token: &'b mut Token, ) -> Pin<&'b mut T>

where Token: LockTokenWrite<Class, Idx>,

Access the guarded value as a pinned mutable reference using a mutable lock token.

Safety

The caller must guarantee that the provided LockToken belongs to the specific lock instance that guards this KCell (rather than a different lock of the same lock class Class), and that this KCell is pinned in memory so its inner value is never moved.

pub unsafe fn as_ptr<Token, Idx>(&self, _token: &Token) -> *const T

where Token: LockTokenRead<Class, Idx>,

Returns a const raw pointer to the guarded value.

Safety

The caller must guarantee that a lock instance guarding this KCell is held continuously while dereferencing or accessing the returned raw pointer.

pub unsafe fn as_mut_ptr<Token, Idx>(&self, _token: &mut Token) -> *mut T

where Token: LockTokenWrite<Class, Idx>,

Returns a mutable raw pointer to the guarded value.

Safety

The caller must guarantee that the lock instance(s) guarding this KCell are held continuously while dereferencing or accessing the returned raw pointer.

pub fn get_inner_mut(&mut self) -> &mut T

Accesses the inner value mutably by bypassing the locking requirements using unique borrow ownership.

pub fn get_pinned_mut(self: Pin<&mut Self>) -> Pin<&mut T>

Projects a pinned reference to the cell to a pinned reference to the inner value.

pub fn init<I, E>(init: I) -> impl Init<Self, E>

where I: Init<T, E>,

Initializes a KCell in place with an Init initializer for its inner value.

pub fn pin_init<I, E>(init: I) -> impl PinInit<Self, E>

where I: PinInit<T, E>,

Initializes a KCell with a PinInit initializer for its inner value.

pub fn into_inner(self) -> T

Unwraps the cell, returning the inner value.

Trait Implementations

impl<T, Class> AsMut<T> for KCell<T, Class>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T, Class> Debug for KCell<T, Class>

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

Formats the value using the given formatter.

impl<T: Default, Class> Default for KCell<T, Class>

fn default() -> Self

Returns the “default value” for a type.

impl<T, Class> From<T> for KCell<T, Class>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T, Class, I, E> Init<KCell<T, Class>, E> for KCellInit<I, Class>

where I: Init<T, E>,

unsafe fn __init(self, slot: *mut KCell<T, Class>) -> Result<(), E>

Initializes slot.

fn chain<F>(self, f: F) -> ChainInit<Self, F, T, E>

where F: FnOnce(&mut T) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value.

impl<T, Class, I, E> PinInit<KCell<T, Class>, E> for KCellInit<I, Class>

where I: PinInit<T, E>,

unsafe fn __pinned_init(self, slot: *mut KCell<T, Class>) -> Result<(), E>

Initializes slot.

fn pin_chain<F>(self, f: F) -> ChainPinInit<Self, F, T, E>

where F: FnOnce(Pin<&mut T>) -> Result<(), E>,

First initializes the value using self then calls the function f with the initialized value.

impl<T: Send, Class> Send for KCell<T, Class>

impl<T: Send, Class> Sync for KCell<T, Class>