Struct koto_memory::KCell

pub struct KCell<T: ?Sized>(/* private fields */);

A mutable value with borrowing checked at runtime

Implementations

impl<T: ?Sized> KCell<T>

pub fn borrow(&self) -> Borrow<'_, T>

Immutably borrows the wrapped value.

Multiple immutable borrows can be made at the same time.

If the value is currently mutably borrowed then this function will block. See try_borrow for a non-blocking version.

pub fn try_borrow(&self) -> Option<Borrow<'_, T>>

Attempts to mutably borrow the wrapped value.

Returns an error if the value is currently mutably borrowed.

pub fn borrow_mut(&self) -> BorrowMut<'_, T>

Mutably borrows the wrapped value.

If the value is currently borrowed then this function will block until the value can be locked. See try_borrow_mut for a non-blocking version.

pub fn try_borrow_mut(&self) -> Option<BorrowMut<'_, T>>

Attempts to mutably borrow the wrapped value.

Returns an error if the value is currently mutably borrowed.

Trait Implementations

impl<T: Debug + ?Sized> Debug for KCell<T>

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

Formats the value using the given formatter.

impl<T: Default + ?Sized> Default for KCell<T>

fn default() -> KCell<T>

Returns the “default value” for a type.

impl<T> From<T> for KCell<T>

fn from(value: T) -> Self

Converts to this type from the input type.