matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

Add documentation for FileLockEntry

Browse source
This commit is contained in:
Matthias Beyer 2017-02-20 15:18:08 +01:00
parent 12e07b32d4
commit 356c17d98b
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
libimagstore/src/store.rs
View file

@ -929,6 +929,10 @@ pub struct FileLockEntry<'a> {
} }
impl<'a> FileLockEntry<'a, > { impl<'a> FileLockEntry<'a, > {
/// Create a new FileLockEntry based on a `Entry` object.
///
/// Only for internal use.
fn new(store: &'a Store, entry: Entry) -> FileLockEntry<'a> { fn new(store: &'a Store, entry: Entry) -> FileLockEntry<'a> {
FileLockEntry { FileLockEntry {
store: store, store: store,
@ -960,7 +964,11 @@ impl<'a> DerefMut for FileLockEntry<'a> {
#[cfg(not(test))] #[cfg(not(test))]
impl<'a> Drop for FileLockEntry<'a> { impl<'a> Drop for FileLockEntry<'a> {
/// This will silently ignore errors, use `Store::update` if you want to catch the errors /// This will silently ignore errors, use `Store::update` if you want to catch the errors
///
/// This might panic if the store was compiled with the early-panic feature (which is not
/// intended for production use, though).
fn drop(&mut self) { fn drop(&mut self) {
use libimagerror::trace::trace_error_dbg; use libimagerror::trace::trace_error_dbg;