matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Doc for Store::retrieve_copy()

Browse source
This commit is contained in:
Matthias Beyer 2017-02-20 16:04:28 +01:00
parent 1f47db3951
commit c82d7bf7bc
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
libimagstore/src/store.rs
View file

@ -663,6 +663,22 @@ impl Store {
/// Retrieve a copy of a given entry, this cannot be used to mutate /// Retrieve a copy of a given entry, this cannot be used to mutate
/// the one on disk /// the one on disk
///
/// TODO: Create Hooks for retrieving a copy
///
/// # Executed Hooks
///
/// - (none yet)
///
/// # Return value
///
/// On success: Entry
///
/// On error:
/// - RetrieveCopyCallError(LockPoisoned()) if the internal write lock cannot be aquierd.
/// - RetrieveCopyCallError(IdLocked()) if the Entry is borrowed currently
/// - Errors StoreEntry::new() might return
///
pub fn retrieve_copy<S: IntoStoreId>(&self, id: S) -> Result<Entry> { pub fn retrieve_copy<S: IntoStoreId>(&self, id: S) -> Result<Entry> {
let id = try!(id.into_storeid()).with_base(self.path().clone()); let id = try!(id.into_storeid()).with_base(self.path().clone());
let entries = match self.entries.write() { let entries = match self.entries.write() {