Struct KeyboardTomlConfig 

pub struct KeyboardTomlConfig {
    pub host: Option<HostConfig>,
    pub rmk: RmkConstantsConfig,
    /* private fields */
}

Configurations for RMK keyboard.

Fields

host: Option<HostConfig>

Set host configurations

rmk: RmkConstantsConfig

RMK config constants

Implementations

impl KeyboardTomlConfig

pub fn get_chip_model(&self) -> Result<ChipModel, String>

pub fn get_chip_config(&self) -> ChipConfig

impl KeyboardTomlConfig

pub fn get_communication_config(&self) -> Result<CommunicationConfig, String>

impl KeyboardTomlConfig

pub fn get_device_config(&self) -> Basic

pub fn get_dependency_config(&self) -> DependencyConfig

impl KeyboardTomlConfig

pub fn get_behavior_config(&self) -> Result<BehaviorConfig, String>

impl KeyboardTomlConfig

pub fn get_board_config(&self) -> Result<BoardConfig, String>

impl KeyboardTomlConfig

pub fn get_host_config(&self) -> HostConfig

impl KeyboardTomlConfig

pub fn get_layout_config( &self, ) -> Result<(LayoutConfig, Vec<Vec<KeyInfo>>), String>

Layout is a mandatory field in toml, so we mainly check the sizes

impl KeyboardTomlConfig

pub fn get_light_config(&self) -> LightConfig

impl KeyboardTomlConfig

pub fn get_storage_config(&self) -> StorageConfig

impl KeyboardTomlConfig

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

pub fn auto_calculate_parameters(&mut self)

Auto calculate some parameters in toml:

• Update morse_max_num to fit all configured morses
• Update max_patterns_per_key to fit the max number of configured (pattern, action) pairs per morse key
• Update peripheral number based on the number of split boards
• TODO: Update controller number based on the number of split boards

impl KeyboardTomlConfig

pub fn get_output_config(&self) -> Result<Vec<OutputConfig>, String>

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.