matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Move documentation to appropriate place

Browse source
This commit is contained in:
Matthias Beyer 2018-01-27 12:10:01 +01:00
parent fdf038ac18
commit 164b6b7f10
1 changed files with 10 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
lib/core/libimagstore/src/store.rs
View file

@ -455,9 +455,17 @@ impl Store {
Walk::new(self.path().clone(), mod_name) Walk::new(self.path().clone(), mod_name)
} }
/// Return the `FileLockEntry` and write to disk /// Write (update) the `FileLockEntry` to disk
/// ///
/// See `Store::_update()`. /// # Return value
///
/// On success: Entry
///
/// On error:
/// - UpdateCallError(LockPoisoned()) if the internal write lock cannot be aquierd.
/// - IdNotFound() if the entry was not found in the stor
/// - Errors Entry::verify() might return
/// - Errors StoreEntry::write_entry() might return
/// ///
pub fn update<'a>(&'a self, entry: &mut FileLockEntry<'a>) -> Result<()> { pub fn update<'a>(&'a self, entry: &mut FileLockEntry<'a>) -> Result<()> {
debug!("Updating FileLockEntry at '{}'", entry.get_location()); debug!("Updating FileLockEntry at '{}'", entry.get_location());
@ -471,16 +479,6 @@ impl Store {
/// This method assumes that entry is dropped _right after_ the call, hence /// This method assumes that entry is dropped _right after_ the call, hence
/// it is not public. /// it is not public.
/// ///
/// # Return value
///
/// On success: Entry
///
/// On error:
/// - UpdateCallError(LockPoisoned()) if the internal write lock cannot be aquierd.
/// - IdNotFound() if the entry was not found in the stor
/// - Errors Entry::verify() might return
/// - Errors StoreEntry::write_entry() might return
///
fn _update<'a>(&'a self, entry: &mut FileLockEntry<'a>, modify_presence: bool) -> Result<()> { fn _update<'a>(&'a self, entry: &mut FileLockEntry<'a>, modify_presence: bool) -> Result<()> {
let mut hsmap = self.entries.write().map_err(|_| SE::from_kind(SEK::LockPoisoned))?; let mut hsmap = self.entries.write().map_err(|_| SE::from_kind(SEK::LockPoisoned))?;