Struct Config 

pub struct Config {
    pub plugin_settings: RwLock<HashMap<String, Value>>,
    pub loaded_configs: RwLock<HashMap<String, UniqueDeviceConfig>>,
    pub loaded_images: RwLock<HashMap<String, ImageCollection>>,
    /* private fields */
}

Struct to keep daemon settings

Fields

plugin_settings: RwLock<HashMap<String, Value>>

Currently loaded plugin settings

loaded_configs: RwLock<HashMap<String, UniqueDeviceConfig>>

Currently loaded device configs

loaded_images: RwLock<HashMap<String, ImageCollection>>

Currently loaded image collections

Implementations

impl Config

pub async fn get(custom_config_path: Option<PathBuf>) -> Config

Reads config and retrieves config struct

pub fn frame_rate(&self) -> u32

Pool rate, defaults to DEFAULT_FRAME_RATE if not set

pub fn reconnect_rate(&self) -> f32

Reconnect rate, defaults to DEFAULT_RECONNECT_TIME if not set

pub fn autosave(&self) -> bool

Autosave option, defaults to true if not set

pub fn plugin_compatibility_checks(&self) -> bool

Plugin compatibility checks, defaults to true if not set

pub fn device_config_path(&self) -> PathBuf

Device config path, defaults to [data_dir]/DEVICE_CONFIG_FOLDER or DEVICE_CONFIG_FOLDER if not set

pub fn plugin_path(&self) -> PathBuf

Plugin folder path, defaults to [config_dir]/PLUGINS_FOLDER or PLUGINS_FOLDER if not set

pub fn font_path(&self) -> PathBuf

Fonts folder path, defaults to [config_dir]/FONTS_FOLDER or FONTS_FOLDER if not set

pub fn plugin_settings_path(&self) -> PathBuf

Plugin settings file path, defaults to [data_dir]/PLUGINS_SETTINGS_FILE or PLUGINS_SETTINGS_FILE if not set

pub fn data_dir(&self) -> &PathBuf

Data path, defaults to dirs::data_dir() if not set

pub fn config_dir(&self) -> &PathBuf

Config path, defaults to dirs::config_dir() if not set

pub async fn load_plugin_settings(&self)

Loads plugin settings from file

pub async fn get_plugin_settings<T: PluginConfig + DeserializeOwned>( &self, ) -> Option<T>

Retrieves plugin settings if it exists

pub async fn set_plugin_settings<T: PluginConfig + Serialize>(&self, value: T)

Sets plugin settings

pub async fn write_plugin_settings(&self)

Writes plugin settings to file

pub async fn reload_device_config( &self, serial: &str, ) -> Result<(), ConfigError>

Reloads device config for specified serial

pub async fn reload_device_configs(&self) -> Result<(), ConfigError>

Reloads all device configs

pub async fn save_device_config(&self, serial: &str) -> Result<(), ConfigError>

Saves device config for specified serial

pub async fn save_device_configs(&self) -> Result<(), ConfigError>

Saves device configs for all serials

pub async fn get_device_config( &self, serial: &str, ) -> Option<UniqueDeviceConfig>

Retrieves device config for specified serial

pub async fn set_device_config(&self, serial: &str, config: DeviceConfig)

Sets device config for specified serial

pub async fn get_all_device_configs(&self) -> Vec<UniqueDeviceConfig>

Gets an array of all device configs

pub async fn disable_device_config(&self, serial: &str) -> bool

Disables a device config, so it will not be loaded by default

pub async fn restore_device_config(&self, serial: &str) -> bool

Restores device config if it exists

pub async fn add_image(&self, serial: &str, image: String) -> Option<String>

Adds base64 image to device config image collection

pub async fn add_image_encode( &self, serial: &str, image: DynamicImage, ) -> Option<String>

Encodes image to base64 and adds it to device config image collection

pub async fn get_images( &self, serial: &str, ) -> Option<HashMap<String, SDSerializedImage>>

Gets images from device config

pub async fn remove_image(&self, serial: &str, identifier: &str) -> bool

Removes image from device config

pub async fn sync_images(&self, serial: &str)

Syncs images with core

pub async fn get_image_collection(&self, serial: &str) -> ImageCollection

Retrieves image collection for device if device exists

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.