Skip to main content

RemovableFlash

Struct RemovableFlash 

Source
pub struct RemovableFlash<F> { /* private fields */ }
Available on crate feature std only.
Expand description

Test double for removable media: any flash that can be made absent.

Wraps an inner flash and gates every operation on a presence flag. While absent, reads fail too, not just writes — a card yanked between writing a spool intent record and reading the next payload must exercise both paths.

The inner flash is retained while absent, so insert restores exactly the bytes that were there before, and into_inner models carrying the card to a computer.

§Example

use sensor_db::mock::{MockFlash, RemovableFlash};

let mut card = RemovableFlash::new(MockFlash::<256, 4096>::new(8 * 4096));
assert!(card.is_present());
card.remove();
assert!(!card.is_present());
card.insert();

Implementations§

Source§

impl<F> RemovableFlash<F>

Source

pub fn new(inner: F) -> Self

Wrap a flash device. The medium starts out present.

Source

pub fn insert(&mut self)

Make the medium present again, with its contents intact.

Source

pub fn remove(&mut self)

Remove the medium cleanly. Subsequent reads and writes fail with MockFlashError::NotPresent.

Source

pub fn yank_after(&mut self, n: u64)

Become absent after n further writes — a surprise yank mid-batch.

The n-th write from now still succeeds; the one after it fails. Use this to land a removal in the middle of a multi-page operation.

Source

pub fn is_present(&self) -> bool

Whether the medium is currently present.

Source

pub fn write_count(&self) -> u64

Total writes attempted while present.

Source

pub fn inner(&self) -> &F

Borrow the wrapped flash, ignoring presence.

Source

pub fn inner_mut(&mut self) -> &mut F

Mutably borrow the wrapped flash, ignoring presence.

Source

pub fn into_inner(self) -> F

Consume the wrapper and return the flash — “carry the card to the laptop”.

Trait Implementations§

Source§

impl<F: Clone> Clone for RemovableFlash<F>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F> ErrorType for RemovableFlash<F>

Source§

type Error = MockFlashError

Errors returned by this NOR flash.
Source§

impl<F> NorFlash for RemovableFlash<F>
where F: NorFlash<Error = MockFlashError>,

Source§

const WRITE_SIZE: usize = F::WRITE_SIZE

The minumum number of bytes the storage peripheral can write
Source§

const ERASE_SIZE: usize = F::ERASE_SIZE

The minumum number of bytes the storage peripheral can erase
Source§

fn erase(&mut self, from: u32, to: u32) -> Result<(), Self::Error>

Erase the given storage range, clearing all data within [from..to]. The given range will contain all 1s afterwards. Read more
Source§

fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error>

If power is lost during write, the contents of the written words are undefined, but the rest of the page is guaranteed to be unchanged. It is not allowed to write to the same word twice. Read more
Source§

impl<F> ReadNorFlash for RemovableFlash<F>
where F: ReadNorFlash<Error = MockFlashError>,

Source§

const READ_SIZE: usize = 1

The minumum number of bytes the storage peripheral can read
Source§

fn read(&mut self, offset: u32, buf: &mut [u8]) -> Result<(), Self::Error>

Read a slice of data from the storage peripheral, starting the read operation at the given address offset, and reading bytes.len() bytes. Read more
Source§

fn capacity(&self) -> usize

The capacity of the peripheral in bytes.
Source§

impl<F> Removable for RemovableFlash<F>

Source§

fn is_present(&self) -> bool

Returns true while the medium is believed present and usable.

Auto Trait Implementations§

§

impl<F> Freeze for RemovableFlash<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for RemovableFlash<F>
where F: RefUnwindSafe,

§

impl<F> Send for RemovableFlash<F>
where F: Send,

§

impl<F> Sync for RemovableFlash<F>
where F: Sync,

§

impl<F> Unpin for RemovableFlash<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for RemovableFlash<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for RemovableFlash<F>
where F: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.