Struct BufferStorage 

pub struct BufferStorage { /* private fields */ }

Simulates a flash storage using a buffer in memory.

This buffer storage can be used in place of an actual flash storage. It is particularly useful for tests and fuzzing, for which it has dedicated functionalities.

This storage tracks how many times words are written between page erase cycles, how many times pages are erased, and whether an operation flips bits in the wrong direction. Operations panic if those conditions are broken (optional). This storage also permits to interrupt operations for inspection or to corrupt the operation.

Implementations

impl BufferStorage

pub fn new(storage: Box<[u8]>, options: BufferOptions) -> BufferStorage

Creates a buffer storage.

Panics

The following preconditions must hold:

• options.word_size must be a power of two.
• options.page_size must be a power of two.
• options.page_size must be word-aligned.
• storage.len() must be page-aligned.

pub fn arm_interruption(&mut self, delay: usize)

Arms an interruption after a given delay.

Before each subsequent mutable operation (write or erase), the delay is decremented if positive. If the delay is elapsed, the operation is saved and the INTERRUPTION error is returned. Subsequent operations will panic until either of:

• The interrupted operation is corrupted.
• The interruption is reset.

Panics

Panics if an interruption is already armed.

pub fn disarm_interruption(&mut self) -> usize

Disarms an interruption that did not trigger.

Returns the remaining delay.

Panics

Panics if any of the following conditions hold:

• An interruption was not armed.
• An interruption was armed and it has triggered.

pub fn reset_interruption(&mut self)

Resets an interruption regardless of triggering.

Panics

Panics if an interruption was not armed.

pub fn corrupt_operation(&mut self, corrupt: BufferCorruptFunction<'_>)

Corrupts an interrupted operation.

Applies the corruption function to the storage. Counters are updated accordingly:

• If a word is fully written, its counter is incremented regardless of whether other words 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 if any of the following conditions hold:

• An interruption was not armed.
• An interruption was armed but did not trigger.
• The corruption function corrupts more bits than allowed.
• The interrupted operation itself would have panicked.

pub fn get_word_writes(&self, word: usize) -> usize

Returns the number of times a word was written.

pub fn get_page_erases(&self, page: usize) -> usize

Returns the number of times a page was erased.

pub fn set_page_erases(&mut self, page: usize, cycle: usize)

Sets the number of times a page was erased.

Trait Implementations

impl Clone for BufferStorage

fn clone(&self) -> BufferStorage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Display for BufferStorage

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Storage for BufferStorage

fn word_size(&self) -> usize

The size of a word in bytes.

fn page_size(&self) -> usize

The size of a page in bytes.

fn num_pages(&self) -> usize

The number of pages in the storage.

fn max_word_writes(&self) -> usize

Maximum number of times a word can be written between page erasures.

fn max_page_erases(&self) -> usize

Maximum number of times a page can be erased.

fn read_slice( &self, index: StorageIndex, length: usize, ) -> Result<Cow<'_, [u8]>, Error>

Reads a byte slice from the storage.

fn write_slice( &mut self, index: StorageIndex, value: &[u8], ) -> Result<(), Error>

Writes a word slice to the storage.

fn erase_page(&mut self, page: usize) -> Result<(), Error>

Erases a page of the storage.