Doc for Store::get()

This commit is contained in:
Matthias Beyer 2017-02-20 16:03:32 +01:00
parent 8867e50618
commit 4e042e4de2

View file

@ -530,7 +530,19 @@ impl Store {
/// Get an entry from the store if it exists. /// Get an entry from the store if it exists.
/// ///
/// This executes the {pre,post}_retrieve_aspects hooks. /// # Executed Hooks
///
/// - Pre get aspects
/// - post get aspects
///
/// # Return value
///
/// On success: Some(FileLockEntry) or None
///
/// On error:
/// - Errors StoreId::into_storeid() might return
/// - Errors Store::retrieve() might return
///
pub fn get<'a, S: IntoStoreId + Clone>(&'a self, id: S) -> Result<Option<FileLockEntry<'a>>> { pub fn get<'a, S: IntoStoreId + Clone>(&'a self, id: S) -> Result<Option<FileLockEntry<'a>>> {
let id = try!(id.into_storeid()).with_base(self.path().clone()); let id = try!(id.into_storeid()).with_base(self.path().clone());