Doc for Store::get()
This commit is contained in:
parent
8867e50618
commit
4e042e4de2
1 changed files with 13 additions and 1 deletions
|
@ -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());
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue