kmwebnet/OpenSK
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix documentation

Browse Source
This commit is contained in:
Julien Cretin
2020-10-23 11:52:21 +02:00
parent f5e6f8728f
commit 34ad35fdc1
1 changed files with 14 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
libraries/persistent_store/src/buffer.rs
View File

@@ -119,7 +119,9 @@ impl BufferStorage {
/// ///
/// # Panics /// # Panics
/// ///
/// Panics if an interruption was not [armed] and if the interruption already triggered. /// Panics if any of the following conditions hold:
/// - An interruption was not [armed].
/// - An interruption was armed and it has triggered.
/// ///
/// [armed]: struct.BufferStorage.html#method.arm_interruption /// [armed]: struct.BufferStorage.html#method.arm_interruption
pub fn disarm_interruption(&mut self) -> usize { pub fn disarm_interruption(&mut self) -> usize {
@@ -139,15 +141,18 @@ impl BufferStorage {
/// Corrupts an interrupted operation. /// Corrupts an interrupted operation.
/// ///
/// Applies the [corruption function] to the storage. Counters are incremented if the operation /// Applies the [corruption function] to the storage. Counters are updated accordingly:
/// is complete at their level, i.e. a word is written and a page is erased if the corruption /// - If a word is fully written, its counter is incremented regardless of whether other words
/// function writes all its bits. /// of the same operation have been fully written.
/// - If a page is fully erased, its counter is incremented (and its word counters are reset).
/// ///
/// # Panics /// # Panics
/// ///
/// Panics if an interruption was not [armed] and if the interruption did not trigger. May also /// Panics if any of the following conditions hold:
/// panic if the corruption function corrupts more bits than allowed or if the interrupted /// - An interruption was not [armed].
/// operation itself would have panicked. /// - An interruption was armed but did not trigger.
/// - The corruption function corrupts more bits than allowed.
/// - The interrupted operation itself would have panicked.
/// ///
/// [armed]: struct.BufferStorage.html#method.arm_interruption /// [armed]: struct.BufferStorage.html#method.arm_interruption
/// [corruption function]: type.BufferCorruptFunction.html /// [corruption function]: type.BufferCorruptFunction.html
@@ -339,7 +344,7 @@ impl core::fmt::Display for BufferStorage {
/// Represents a storage operation. /// Represents a storage operation.
/// ///
/// It is polymorphic over the ownership of the byte slice ot avoid unnecessary copies. /// It is polymorphic over the ownership of the byte slice to avoid unnecessary copies.
#[derive(Clone, Debug, PartialEq, Eq)] #[derive(Clone, Debug, PartialEq, Eq)]
enum BufferOperation<ByteSlice: Borrow<[u8]>> { enum BufferOperation<ByteSlice: Borrow<[u8]>> {
/// Represents a write operation. /// Represents a write operation.
@@ -459,7 +464,7 @@ mod tests {
max_page_erases: 3, max_page_erases: 3,
strict_write: true, strict_write: true,
}; };
// Those words are decreasing bit patterns. Bits are only changed from 1 to 0 and at last one // Those words are decreasing bit patterns. Bits are only changed from 1 to 0 and at least one
// bit is changed. // bit is changed.
const BLANK_WORD: &[u8] = &[0xff, 0xff, 0xff, 0xff]; const BLANK_WORD: &[u8] = &[0xff, 0xff, 0xff, 0xff];
const FIRST_WORD: &[u8] = &[0xee, 0xdd, 0xbb, 0x77]; const FIRST_WORD: &[u8] = &[0xee, 0xdd, 0xbb, 0x77];