foxess 1.1.0

Rust library for communication with FoxESS Cloud
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

//! This module hosts the [SettableSettingSpec] trait that can be implemented for marker structs to be used together with typed set functions.
//!

use crate::fox_settings::SettingSpec;

/// A trait for settings that can be updated on the FoxESS cloud.
///
/// Types implementing this trait provide a way to format a value back into a string
/// for API requests.
pub trait SettableSettingSpec: SettingSpec {
    /// Formats the value into a string suitable for an API request.
    ///
    /// # Arguments
    /// * `value` - A reference to the value to be formatted.
    ///
    /// # Returns
    /// * `String` - The formatted string.
    fn format(value: &Self::Value) -> String;
}