Struct fixity::map::BatchMap

pub struct BatchMap<'f>(_);

Implementations

impl<'f> BatchMap<'f>

pub fn new<C, W>(inner_map: BatchMap<'f, C, W>) -> Self where
    C: CacheRead + CacheWrite,
    W: Workspace, 

pub fn clear(&mut self)

Drop the internal change cache that has not yet been staged or committed to storage.

Examples

let f = Fixity::memory();
let mut m = f.map(Path::new()).batch();
m.insert("foo", "bar");
m.clear();
assert!(m.get("foo").await.unwrap().is_none());

pub fn insert<K, V>(&mut self, key: K, value: V) where
    K: Into<Key>,
    V: Into<Value>, 

Insert a value into the map to later be staged or committed.

This value is not written to the store until Self::stage or Self::commit is called, but it can be retrived from the internal cache.

Examples

let f = Fixity::memory();
let mut m_1 = f.map(Path::new()).batch();
let m_2 = f.map(Path::new()).batch();
m_1.insert("foo", "bar");
// get pulls from in-memory cache, awaiting stage/commit.
assert_eq!(m_1.get("foo").await.unwrap(), Some("bar".into()));
// not yet written to storage.
assert_eq!(m_2.get("foo").await.unwrap(), None);

pub async fn get<K>(&self, key: K) -> Result<Option<Value>, Error> where
    K: Into<Key>, 

pub async fn stage(&mut self) -> Result<Addr, Error>

Write any changes to storage, staging them for a later commit.

Examples

let f = Fixity::memory();
let mut m_1 = f.map(Path::new()).batch();
let m_2 = f.map(Path::new()).batch();
m_1.insert("foo", "bar");
// not yet written to storage.
assert_eq!(m_2.get("foo").await.unwrap(), None);
let _staged_addr = m_1.stage().await.unwrap();
// now in storage.
assert_eq!(m_2.get("foo").await.unwrap(), Some("bar".into()));

pub async fn commit(&mut self) -> Result<Addr, Error>

Write any staged changes at the current [Path] into the workspace.

Examples

let f = fixity::fixity::Fixity::memory();
let mut m_1 = f.map(Path::new()).batch();
let m_2 = f.map(Path::new()).batch();
m_1.insert("foo", "bar");
// not yet written to storage.
assert_eq!(m_2.get("foo").await.unwrap(), None);
m_1.stage().await.unwrap();
m_1.commit().await.unwrap();
// now in storage.
assert_eq!(m_2.get("foo").await.unwrap(), Some("bar".into()));