Struct sppparse::SparseRef

pub struct SparseRef<S: DeserializeOwned + Serialize + SparsableTrait> { /* fields omitted */ }

An owned dynamic ref

SparseRef will render dynamically the pointed value.

It uses a SparseState to render itself in order to limit the IO calls at a minimum. It will deserialize into the desired type.

If the SparseStateFile used to render the object changes, SparseRef will deserialize it again in order to always be up to date.

Implementations

impl<S: DeserializeOwned + Serialize + SparsableTrait> SparseRef<S>

pub fn val(&self) -> &Box<SparsePointedValue<S>>

The value deserialized value, if any

pub fn utils(&self) -> &SparseMetadata

Metadata about the pointer

Trait Implementations

impl<S: Clone + DeserializeOwned + Serialize + SparsableTrait> Clone for SparseRef<S>

pub fn clone(&self) -> SparseRef<S>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug + DeserializeOwned + Serialize + SparsableTrait> Debug for SparseRef<S>

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

Formats the value using the given formatter.

impl<'de, S: DeserializeOwned + Serialize + SparsableTrait> Deserialize<'de> for SparseRef<S> where
    S: DeserializeOwned + Serialize + SparsableTrait, 

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<S: DeserializeOwned + Serialize + SparsableTrait> Serialize for SparseRef<S> where
    S: DeserializeOwned + Serialize + SparsableTrait, 

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<S> Sparsable for SparseRef<S> where
    S: DeserializeOwned + Serialize + SparsableTrait, 

pub fn sparse_init(
    &mut self,
    state: &mut SparseState,
    metadata: &SparseMetadata,
    depth: u32
) -> Result<(), SparseError>

Initialize recusively a Sparsable pointer

pub fn sparse_updt<'a>(
    &mut self,
    state: &mut SparseState,
    metadata: &SparseMetadata,
    depth: u32
) -> Result<(), SparseError>

Update recusively a Sparsable pointer

pub fn check_depth(depth: u32) -> Result<(), SparseError>

Check if the current depth isn't too much. This is the cyclic pointer protection mechanism

impl<S> SparsePointer<S> for SparseRef<S> where
    S: DeserializeOwned + Serialize + SparsableTrait, 

pub fn check_version<'a>(
    &'a self,
    state: &'a SparseState
) -> Result<(), SparseError>

Check if the inner value is outdated

pub fn get(&self) -> Result<SparseValue<'_, S>, SparseError>

Get the inner value of the pointer

pub fn get_mut(
    &mut self,
    state_cell: Rc<RefCell<SparseState>>
) -> Result<SparseValueMut<'_, S>, SparseError>

Get the inner value of the pointer (mutable)

pub fn self_reset(
    &mut self,
    state: &mut SparseState,
    metadata: &SparseMetadata,
    depth: u32
) -> Result<(), SparseError>

Reset the inner value and parse it again from the state