Struct Config

pub struct Config { /* private fields */ }

Manages the configuration

Implementations

impl Config

pub fn local() -> Result<Self, Box<dyn Error + Send + Sync + 'static>>

Create a configuration based on file named local.json5.

Will search in the directories mentioned in Examples. This file should contain a configuration that only connects to entities on same host.

Errors

Returns a std::io::Error, if file does not exist in any of the places or is not accessible.

pub fn client() -> Result<Self, Box<dyn Error + Send + Sync + 'static>>

Create a configuration based on file named client.json5.

Will search in the directories mentioned in Examples. This file should contain a configuration that creates an entity in client mode.

Errors

Returns a std::io::Error, if file does not exist in any of the places or is not accessible.

pub fn peer() -> Result<Self, Box<dyn Error + Send + Sync + 'static>>

Create a configuration based on file named peer.json5.

Will search in the directories mentioned in Examples. This file should contain a configuration that creates an entity in peer mode.

Errors

Returns a std::io::Error, if file does not exist in any of the places or is not accessible.

pub fn router() -> Result<Self, Box<dyn Error + Send + Sync + 'static>>

Create a configuration based on file named router.json5.

Will search in the directories mentioned in Examples. This file should contain a configuration that creates an entity in router mode.

Errors

Returns a std::io::Error, if file does not exist in any of the places or is not accessible.

pub fn from_file( filename: &str, ) -> Result<Self, Box<dyn Error + Send + Sync + 'static>>

Create a configuration based on file with given filename.

Will search in the directories mentioned in Examples.

Errors

Returns a std::io::Error, if file does not exist in any of the places or is not accessible.

pub const fn zenoh_config(&self) -> &Config

Method to extract the zenoh configuration from Config.

Can be passed to zenoh::open().

pub const fn sessions(&self) -> &Option<Vec<Session>>

Method to get access to the the sessions in Config.

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() -> Self

Create a default configuration

Will search for a configuration file with name “default.json5” in the directories mentioned in Examples. This file should contain the wanted default configuration. If no file is found, it will create a defined minimal default configuration. Currently this is just a default zenoh peer configuration which connects to peers in same subnet.

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.