Struct ModuleSettings 

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

A struct containing settings for multiple signaling modules, each associated with the module’s namespace.

Implementations

impl ModuleSettings

pub fn new() -> Self

Create a new empty ModuleSettings.

pub fn get<T: SignalingModuleSettings>(&self) -> Result<Option<T>, Error>

Get the settings for a specific module

pub fn insert<T: SignalingModuleSettings>( &mut self, data: &T, ) -> Result<(), Error>

Set the settings for a specific module

If an entry with the namespace already exists, it will be overwritten.

pub fn insert_empty(&mut self, namespace: ModuleId)

Insert an empty object for the specified module namespace

This is useful for adding modules that don’t require any settings.

pub fn remove(&mut self, namespace: &ModuleId) -> Option<Value>

Remove the settings for a specified module.

pub fn retain<F>(&mut self, f: F)

where F: FnMut(&ModuleId, &mut Value) -> bool,

Retains only the entries specified by the predicate

pub fn ids(&self) -> impl Iterator<Item = &ModuleId>

Returns an iterator over the module IDs in the settings

pub fn contains(&self, namespace: ModuleId) -> bool

Checks if specified module id is present in the settings

Trait Implementations

impl Clone for ModuleSettings

fn clone(&self) -> ModuleSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleSettings

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

Formats the value using the given formatter.

impl Default for ModuleSettings

fn default() -> ModuleSettings

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModuleSettings

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ModuleSettings

impl ExampleData for ModuleSettings

fn example_data() -> Self

Get an example instance of the current datatype.

impl PartialEq for ModuleSettings

fn eq(&self, other: &ModuleSettings) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ModuleSettings

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModuleSettings