Struct SparseState

Source
pub struct SparseState { /* private fields */ }
Expand description

§State in which the documents are cached

Implementations§

Source§

impl SparseState

Source

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

Create a new SparseState from a root file

Source

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

Create a new SparseState from an in memory Value

Source

pub fn get_root_path(&self) -> &PathBuf

Get the root path of the state, if any

Source

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

Source

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

Deserialize the root document from the state to the type S

Source

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

Source

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

Deserialize a file from the state to the type S

Source

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

Source

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

Deserialize a file from the state to the type S

Source

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§

Source§

impl Clone for SparseState

Source§

fn clone(&self) -> SparseState

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SparseState

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V