Struct Config

pub struct Config(/* private fields */);

Zenoh configuration.

Most options are optional as a way to keep defaults flexible. Some of the options have different default values depending on the rest of the configuration.

To construct a configuration, we advise that you use a configuration file (JSON, JSON5 and YAML are currently supported, please use the proper extension for your format as the deserializer will be picked according to it).

Implementations

impl Config

pub const DEFAULT_CONFIG_PATH_ENV: &'static str = "ZENOH_CONFIG"

Default environment variable containing the file path used in Config::from_env.

pub fn from_env() -> ZResult<Self>

Load configuration from the file path specified in the Self::DEFAULT_CONFIG_PATH_ENV environment variable.

pub fn from_file<P: AsRef<Path>>(path: P) -> ZResult<Self>

Load configuration from the file at path.

pub fn from_json5(input: &str) -> ZResult<Config>

Load configuration from the JSON5 string input.

pub fn remove<K: AsRef<str>>(&mut self, key: K) -> ZResult<()>

pub fn insert_json5(&mut self, key: &str, value: &str) -> ZResult<()>

Inserts configuration value value at key.

pub fn get_json(&self, key: &str) -> ZResult<String>

Returns a JSON string containing the configuration at key.

pub fn from_deserializer<'d, D: Deserializer<'d>>( d: D, ) -> Result<Self, Result<Self, D::Error>>

where Self: Deserialize<'d>,

Available on crate feature unstable only.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

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 Display for Config

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

Formats the value using the given formatter.

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.