Struct SerialSettingsPlatform

pub struct SerialSettingsPlatform<C, F, S> {
    pub interface: BestEffortInterface<S>,
    pub _settings_marker: PhantomData<C>,
    pub storage: F,
    pub metadata: &'static ApplicationMetadata,
}

Fields

interface: BestEffortInterface<S>

The interface to read/write data to/from serially (via text) to the user.

_settings_marker: PhantomData<C>

storage: F

The storage mechanism used to persist settings to between boots.

metadata: &'static ApplicationMetadata

Metadata associated with the application

Implementations

impl<C, F, S> SerialSettingsPlatform<C, F, S>

where C: TreeDeserializeOwned + TreeSerialize + TreeSchema, F: NorFlash,

pub fn load(structure: &mut C, storage: &mut F)

Trait Implementations

impl<C, F, S> Platform for SerialSettingsPlatform<C, F, S>

where C: Settings, F: NorFlash, S: EioWrite + WriteReady + ReadReady + EioRead,

type Interface = BestEffortInterface<S>

This type specifies the interface to the user, for example, a USB CDC-ACM serial port.

type Settings = C

type Error = Error<<F as ErrorType>::Error>

fn fetch<'a>( &mut self, buf: &'a mut [u8], key: &[u8], ) -> Result<Option<&'a [u8]>, Self::Error>

Fetch a value from persisten storage

fn store( &mut self, buf: &mut [u8], key: &[u8], value: &[u8], ) -> Result<(), Self::Error>

Store a value to persistent storage

fn clear(&mut self, buf: &mut [u8], key: &[u8]) -> Result<(), Self::Error>

Remove a key from storage.

fn cmd(&mut self, cmd: &str)

Execute a platform specific command.

fn interface_mut(&mut self) -> &mut Self::Interface

Return a mutable reference to the Interface.