Struct KeyboardTomlConfig 

pub struct KeyboardTomlConfig { /* private fields */ }

Configurations for RMK keyboard.

Implementations

impl KeyboardTomlConfig

pub fn behavior(&self) -> Result<Behavior, String>

Resolve behavioral configuration from TOML config.

impl KeyboardTomlConfig

pub fn build_constants( &self, active_features: &[&str], ) -> Result<BuildConstants, String>

Build compile-time constants from the configuration.

active_features contains feature names enabled on the downstream crate (e.g. ["split", "_ble"]). These are matched against subscriber_default.toml to auto-bump event subscriber counts.

impl KeyboardTomlConfig

pub fn hardware(&self) -> Result<Hardware, String>

Resolve hardware configuration from TOML config.

impl KeyboardTomlConfig

pub fn host(&self) -> Host

Resolve host-tool configuration from TOML config.

impl KeyboardTomlConfig

pub fn identity(&self) -> Result<Identity, String>

Resolve keyboard identity from TOML config.

impl KeyboardTomlConfig

pub fn keymap(&self) -> Result<Keymap, String>

Resolve the keymap configuration from TOML config.

impl KeyboardTomlConfig

pub fn layout(&self) -> Result<Layout, String>

Resolve the physical layout blob from the [layout] section.

impl KeyboardTomlConfig

pub fn new_from_toml_path_with_event_defaults<P: AsRef<Path>>( config_toml_path: P, ) -> Self

Load keyboard.toml with event defaults only.

This is used in build.rs where we only need [rmk] and [event] constants, and should not require [keyboard.board]/[keyboard.chip].

pub fn new_from_toml_path<P: AsRef<Path>>(config_toml_path: P) -> Self

pub fn dfu_storage_conflict(&self) -> Option<DfuStorageConflict>

Detect a [storage]/[dfu] conflict in the user’s keyboard.toml.

While DFU is enabled, the storage region is a partition fixed by the bootloader’s linker script (rmk-memory.x, generated by rmk-boot’s build.rs): start_addr is overridden to the partition start and num_sectors must match the partition size. Explicit [storage] values have no effect there, so return which keys the user set.

Trait Implementations

impl Clone for KeyboardTomlConfig

fn clone(&self) -> KeyboardTomlConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardTomlConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyboardTomlConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.