Struct Pack

pub struct Pack<T>
where
    T: Serialize + Sized + Clone,
{ /* private fields */ }

Pack Small FS layer around type T Pack is responsible to sync T to the filesystem.

Implementations

impl<'a, T> Pack<T>

where for<'de> T: Serialize + Deserialize<'de> + Default + Sized + Clone + 'a + TryFrom + From<<T as TryFrom>::TryFrom>,

pub fn try_load_from_path(path: PathBuf) -> PackResult<Pack<T>>

pub fn try_load_or_init(path: PathBuf, file_id: &str) -> PackResult<Pack<T>>

impl<'a, T> Pack<T>

where for<'de> T: Serialize + Deserialize<'de> + Default + Sized + Clone + 'a,

pub fn from_str(buffer: &str, path: PathBuf) -> PackResult<Pack<T>>

pub fn load_from_path(path: PathBuf) -> PackResult<Pack<T>>

Load Pack from Path If Path is file and exists, then it tries to load then deserialize. Otherwise returns PackError.

pub fn load_or_init(path: PathBuf, file_id: &str) -> PackResult<Pack<T>>

Load or init Pack from Path If Path does not exist, then it tries to create; Otherwise call Pack::load_from_path(Path).

pub fn save(&self) -> PackResult<()>

Save Pack manually to FS. Returns PackError if something wrong occures.

pub fn update<F, R>(&mut self, f: F) -> PackResult<R>

where F: FnOnce(&mut T) -> R,

Update Pack Tries to update T, if SUCCESS then tries to save to FS, if SUCCESS returns R. If Fail, then doing data T rollback to backup, then return PackError.

pub fn get<F, R>(&self, f: F) -> R

where F: Fn(&T) -> R,

Get(Fn) -> R Access data through closure Unmutable data access

pub fn map<F, R>(&self, f: F) -> R

where F: Fn(&T) -> R,

Map(Fn) -> R Syntactic sugar for Get(Fn) -> R

pub fn as_mut(&mut self) -> PackGuard<'_, T>

as_mut() -> PackGuard<’a, T> returns

pub fn into_inner(self) -> T

pub fn unpack(&self) -> &T

Trait Implementations

impl<T> Deref for Pack<T>

where T: Serialize + Sized + Clone,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.