Struct FileBackedValue 

pub struct FileBackedValue<T>
where
    T: Serialize + DeserializeOwned,
{ /* private fields */ }

Implementations

impl<T> FileBackedValue<T>

where T: Serialize + DeserializeOwned,

pub fn new(filename: &str) -> Self

pub fn new_at(filename: &str, dir: &Path) -> Self

pub fn path(&self) -> PathBuf

Path to the backing file.

pub fn clear(&mut self) -> Result<()>

Clear the currently stored value and remove the backing file.

pub fn set_dirty_time(&mut self, dirty_time: Duration)

If the time since the file was last edited is longer ago than dirty_time, require a recomputation of the value and a writeback to the file. If this value is not set, the file is only ever read once.

pub fn set_dirty(&mut self) -> Option<T>

Make this file dirty, requiring a recomputation the next time a value is get. Returns the currently stored value, if any.

pub fn get(&mut self) -> FileBackedValueResult<Option<&T>>

Get the current value, which might be None if the backing file does not yet exist.

pub fn get_or_insert(&mut self, default: T) -> FileBackedValueResult<&T>

pub fn get_or_insert_with<F>(&mut self, default: F) -> FileBackedValueResult<&T>

where F: FnOnce() -> T,

pub fn insert(&mut self, value: T) -> &T

Inserts value into the option and writes it to the backing file. Returns a mutable reference to the value.