Struct kubos_service::Config

pub struct Config { /* fields omitted */ }

KubOS config used by either Apps or Services. KubOS config files use the TOML format, and can may contain multiple named Categories. Typically each category corresponds to an App or Service name. This allows one config file to store configuration for multiple Apps / Services at a time.

Example KubOS config files for a Service called my-service with an IP/port binding

[my-service]
my-property = "value"

[my-service.addr]
ip = 0.0.0.0
port = 8181

When addr, addr.ip, or addr.port are not provided in the config file, the default IP "127.0.0.1" and default port 8080 are used instead.

Methods

impl Config

pub fn new(name: &str) -> Config

Creates and parses configuration data from the system configuration file or the path passed as the '-c' or '--config' option to this executable.

Arguments

name - Category name used as a key in the config file

pub fn new_from_path(name: &str, path: String) -> Config

Creates and parses configuration data from the passed in configuration path.

Arguments

name - Category name used as a key in the config file path - Path to configuration file

pub fn new_from_str(name: &str, config: &str) -> Config

Creates and parses configuration data from the passed in configuration string.

Arguments

name - Category name used as a key in the config config - Config data as a string

pub fn hosturl(&self) -> String

Returns the configured hosturl string in the following format (using IPv4 addresses) - 0.0.0.0:0000

pub fn raw(&self) -> Value

Returns the category's configuration information in the toml::Value format. This will contain the ip/port if provided, along with any other configuration information found in the config file.

Examples

use kubos_system::Config;

let config = Config::new("example-service");
let raw = config.raw();
let bus = raw["bus"].as_str();

pub fn get(&self, key: &str) -> Option<Value>

Performs a get on the raw config data

Arguments

key - Key of value to get from config

Trait Implementations

impl Default for Config

fn default() -> Config

Returns the "default value" for a type.

impl Debug for Config

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

Formats the value using the given formatter.