Skip to main content

AsyncFlash

Struct AsyncFlash 

Source
pub struct AsyncFlash<F> { /* private fields */ }
Available on crate features async and std only.
Expand description

Thin async adapter over any sync flash, implementing the async flash traits.

The wrapped devices here are in-memory, so the “async” operations complete immediately — they delegate straight to the sync implementation. This exists so async code can be exercised without an executor or real hardware.

Page and sector geometry is inherited from the wrapped device, so this composes with RemovableFlash without restating the constants.

Implementations§

Source§

impl<const PAGE_SIZE: usize, const SECTOR_SIZE: usize> AsyncFlash<MockFlash<PAGE_SIZE, SECTOR_SIZE>>

Source

pub fn new(size: usize) -> Self

Create a new async mock flash of size bytes.

§Panics

Panics if size is not a multiple of SECTOR_SIZE.

Source§

impl<F> AsyncFlash<F>

Source

pub fn wrap(inner: F) -> Self

Wrap an existing flash device in the async adapter.

Source

pub fn inner(&self) -> &F

Borrow the wrapped device (e.g. to configure power-loss injection).

Source

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

Mutably borrow the wrapped device.

Source

pub fn into_inner(self) -> F

Consume the adapter and return the wrapped device.

Trait Implementations§

Source§

impl<F: Clone> Clone for AsyncFlash<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> ErrorType for AsyncFlash<F>

Source§

type Error = <F as ErrorType>::Error

Errors returned by this NOR flash.
Source§

impl<F: NorFlash> NorFlash for AsyncFlash<F>

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§

async 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§

async 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> ReadNorFlash for AsyncFlash<F>

Source§

const READ_SIZE: usize = F::READ_SIZE

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

async 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> Removable for AsyncFlash<F>

Source§

fn is_present(&self) -> bool

Returns true while the medium is believed present and usable.

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<F> UnwindSafe for AsyncFlash<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.