Struct SparseState

pub struct SparseState { /* private fields */ }

State in which the documents are cached

Implementations

impl SparseState

pub fn new_from_file(path: PathBuf) -> Result<Self, SparseError>

Create a new SparseState from a root file

pub fn new_from_value(path: PathBuf, val: Value) -> Result<Self, SparseError>

Create a new SparseState from an in memory Value

pub fn get_root_path(&self) -> &PathBuf

Get the root path of the state, if any

pub fn get_state_file<'a>( &'a self, path: &Path, ) -> Result<&'a SparseStateFile, SparseError>

pub fn parse_root<S: DeserializeOwned + Serialize + SparsableTrait>( &mut self, ) -> Result<S, SparseError>

Deserialize the root document from the state to the type S

pub fn parse_file<S: DeserializeOwned + Serialize + SparsableTrait>( &mut self, path: PathBuf, ) -> Result<S, SparseError>

Deserialize a document from the state to the type S

pub fn add_value( &mut self, path: PathBuf, value: Value, ) -> Result<(), SparseError>

Deserialize a file from the state to the type S

pub fn add_obj<S: DeserializeOwned + Serialize + SparsableTrait>( &mut self, path: PathBuf, obj: &mut S, ) -> Result<(), SparseError>

Deserialize a file from the state to the type S

pub fn add_file(&mut self, path: PathBuf) -> Result<(), SparseError>

Deserialize a file from the state to the type S

pub fn save_to_disk( &self, format: Option<SparseFileFormat>, ) -> Result<(), SparseError>

Write all the files in the states to disks It’ll try not to modify anything until it’s sure it can open every file for writing

Trait Implementations

impl Clone for SparseState

fn clone(&self) -> SparseState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SparseState

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

Formats the value using the given formatter.