Skip to main content

StableCell

Struct StableCell 

Source
pub struct StableCell<T: Storable, M: Memory = DefaultMemoryImpl> { /* private fields */ }
Expand description

StableCell

An application value cached in memory and persisted in an exclusive Storage allocation. Dropping the Cell releases its lease without changing its bytes.

Implementations§

Source§

impl<T: Storable, M: Memory> StableCell<T, M>

Source

pub fn create( memory: RuntimeMemory<M>, value: T, ) -> Result<Self, CollectionError>

Create a Cell only in an empty allocation.

§Errors

Returns NotEmpty without mutation if the allocation is nonempty, or Growth if its initial reservation cannot accommodate the encoding.

§Panics

Panics if encoding fails, violates the declared bound, or backing IO fails. A native mutation panic poisons the backing owner.

Source

pub fn reset( memory: RuntimeMemory<M>, value: T, ) -> Result<Self, CollectionError>

Explicitly replace an allocation’s contents with a new Cell.

§Errors

Returns Growth if the allocation cannot accommodate the encoding.

§Panics

Panics if encoding fails, violates the declared bound, or backing IO fails. A native mutation panic poisons the backing owner.

Source

pub fn load( memory: RuntimeMemory<M>, maximum: usize, ) -> Result<Self, CollectionError>

Open a Cell without modifying its allocation.

The smaller of maximum and the type’s declared ceiling is checked before allocating or reading the application payload.

§Errors

Returns a Cell framing error if framing, extent or size admission fails.

§Panics

Panics if decoding fails, the length violates a fixed-size codec bound, or backing IO fails. Decode failure releases the lease without poisoning the owner or changing the persisted image.

Source

pub const fn get(&self) -> &T

Borrow the cached value without accessing backing memory or its codec.

Source

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

Persist a replacement and return the previous cached value.

§Panics

Panics on encoding or bound failure, refused growth, or backing IO failure. A native mutation panic poisons the backing owner; subsequent backing access and new leases are refused.

Auto Trait Implementations§

§

impl<T, M = Rc<RefCell<Vec<u8>>>> !RefUnwindSafe for StableCell<T, M>

§

impl<T, M = Rc<RefCell<Vec<u8>>>> !Send for StableCell<T, M>

§

impl<T, M = Rc<RefCell<Vec<u8>>>> !Sync for StableCell<T, M>

§

impl<T, M = Rc<RefCell<Vec<u8>>>> !UnwindSafe for StableCell<T, M>

§

impl<T, M> Forget for StableCell<T, M>

§

impl<T, M> Freeze for StableCell<T, M>
where RuntimeMemory<M>: Freeze, T: Freeze,

§

impl<T, M> Move for StableCell<T, M>

§

impl<T, M> Unpin for StableCell<T, M>
where RuntimeMemory<M>: Unpin, T: Unpin,

§

impl<T, M> UnsafeUnpin for StableCell<T, M>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.