Trait freya::prelude::Storage

pub trait Storage<Data = ()>: AnyStorage + 'static {
    // Required methods
    fn try_read(
        pointer: GenerationalPointer<Self>,
    ) -> Result<Self::Ref<'static, Data>, BorrowError>;
    fn try_write(
        pointer: GenerationalPointer<Self>,
    ) -> Result<Self::Mut<'static, Data>, BorrowMutError>;
    fn new(
        value: Data,
        caller: &'static Location<'static>,
    ) -> GenerationalPointer<Self>;
    fn new_rc(
        value: Data,
        caller: &'static Location<'static>,
    ) -> GenerationalPointer<Self>;
    fn new_reference(
        inner: GenerationalPointer<Self>,
    ) -> Result<GenerationalPointer<Self>, BorrowError>;
    fn change_reference(
        pointer: GenerationalPointer<Self>,
        rc_pointer: GenerationalPointer<Self>,
    ) -> Result<(), BorrowError>;
}

A trait for a storage backing type. (RefCell, RwLock, etc.)

Required Methods

fn try_read( pointer: GenerationalPointer<Self>, ) -> Result<Self::Ref<'static, Data>, BorrowError>

Try to read the value. Returns None if the value is no longer valid.

fn try_write( pointer: GenerationalPointer<Self>, ) -> Result<Self::Mut<'static, Data>, BorrowMutError>

Try to write the value. Returns None if the value is no longer valid.

fn new( value: Data, caller: &'static Location<'static>, ) -> GenerationalPointer<Self>

Create a new memory location. This will either create a new memory location or recycle an old one.

fn new_rc( value: Data, caller: &'static Location<'static>, ) -> GenerationalPointer<Self>

Create a new reference counted memory location. This will either create a new memory location or recycle an old one.

fn new_reference( inner: GenerationalPointer<Self>, ) -> Result<GenerationalPointer<Self>, BorrowError>

Reference another location if the location is valid

This method may return an error if the other box is no longer valid or it is already borrowed mutably.

fn change_reference( pointer: GenerationalPointer<Self>, rc_pointer: GenerationalPointer<Self>, ) -> Result<(), BorrowError>

Change the reference a signal is pointing to

This method may return an error if the other box is no longer valid or it is already borrowed mutably.

Object Safety

This trait is not object safe.

Implementors

impl<T> Storage<T> for SyncStorage

where T: Sync + Send + 'static,

impl<T> Storage<T> for UnsyncStorage

where T: 'static,