Struct CanlinkConfig 

pub struct CanlinkConfig {
    pub backend: BackendConfig,
}

Complete configuration file structure.

Represents the top-level structure of a canlink.toml configuration file.

Examples

[backend]
backend_name = "mock"
retry_count = 3
retry_interval_ms = 1000
device_index = 0

Fields

backend: BackendConfig

Backend configuration

Implementations

impl CanlinkConfig

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, CanError>

Load configuration from a TOML file.

Arguments

• path - Path to the TOML configuration file

Errors

Returns CanError::ConfigError if the file cannot be read or parsed.

Examples

use canlink_hal::CanlinkConfig;

let config = CanlinkConfig::from_file("canlink.toml").unwrap();
println!("Backend: {}", config.backend.backend_name);

pub fn parse_toml(s: &str) -> Result<Self, CanError>

Parse configuration from a TOML string.

Errors

Returns CanError::ConfigError if the TOML is invalid.

Examples

use canlink_hal::CanlinkConfig;

let toml = r#"
[backend]
backend_name = "mock"
"#;

let config = CanlinkConfig::parse_toml(toml).unwrap();
assert_eq!(config.backend.backend_name, "mock");

pub fn with_backend(backend_name: impl Into<String>) -> Self

Create a default configuration with the specified backend.

Examples

use canlink_hal::CanlinkConfig;

let config = CanlinkConfig::with_backend("mock");
assert_eq!(config.backend.backend_name, "mock");

Trait Implementations

impl Clone for CanlinkConfig

fn clone(&self) -> CanlinkConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanlinkConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CanlinkConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CanlinkConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.