Struct zenoh_config::PluginsConfig

pub struct PluginsConfig { /* private fields */ }

This part of the configuration is highly dynamic (any serde_json::Value may be put in there), but should follow this scheme:

plugins: {
    // `plugin_name` must be unique per configuration, and will be used to find the appropriate
    // dynamic library to load if no `__path__` is specified
    [plugin_name]: {
        // Defaults to `false`. Setting this to `true` does 2 things:
        // * If `zenohd` fails to locate the requested plugin, it will crash instead of logging an error.
        // * Plugins are expected to check this value to set their panic-behaviour: plugins are encouraged
        //   to panic upon non-recoverable errors if their `__required__` flag is set to `true`, and to
        //   simply log them otherwise
        __required__: bool,
        // The path(s) where the plugin is expected to be located.
        // If none is specified, `zenohd` will search for a `<dylib_prefix>zenoh_plugin_<plugin_name>.<dylib_suffix>` file in the search directories.
        // If any path is specified, file-search will be disabled, and the first path leading to
        // an existing file will be used
        __path__: string | [string],
        // [plugin_name] may require additional configuration
        ...
    }
}

Implementations

impl PluginsConfig

pub fn sift_privates(&mut self)

pub fn load_requests(&self) -> impl Iterator<Item = PluginLoad> + '_

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

Trait Implementations

impl Clone for PluginsConfig

fn clone(&self) -> PluginsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PluginsConfig

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

Formats the value using the given formatter.

impl Default for PluginsConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Deserialize<'a> for PluginsConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PluginsConfig

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl ValidatedMap for PluginsConfig

fn insert<'d, D: Deserializer<'d>>( &mut self, key: &str, deserializer: D ) -> Result<(), InsertionError>

where InsertionError: From<D::Error>,

fn get<'a>(&'a self, key: &str) -> Result<&'a dyn Any, GetError>

type Keys = Vec<String>

fn keys(&self) -> Self::Keys

fn get_json(&self, key: &str) -> Result<String, GetError>

fn insert_json5(&mut self, key: &str, value: &str) -> Result<(), InsertionError>

impl<'a> ValidatedMapAssociatedTypes<'a> for PluginsConfig

type Accessor = &'a (dyn Any + 'static)