Struct mz_adapter::config::params::SynchronizedParameters

pub struct SynchronizedParameters {
    system_vars: SystemVars,
    synchronized: BTreeSet<&'static str>,
    modified: BTreeSet<&'static str>,
}

A struct that defines the system parameters that should be synchronized

Fields

system_vars: SystemVars

The backing SystemVars instance. Synchronized parameters are exactly those that are returned by SystemVars::iter_synced.

synchronized: BTreeSet<&'static str>

A set of names identifying the synchronized variables from the above system_vars.

Derived from the above at construction time with the assumption that this set cannot change during the lifecycle of the SystemVars instance.

modified: BTreeSet<&'static str>

A set of names that identifies the synchronized parameters that have been modified by the frontend and need to be pushed to backend.

Implementations

impl SynchronizedParameters

pub fn new(system_vars: SystemVars) -> Self

pub fn is_synchronized(&self, name: &str) -> bool

pub fn synchronized(&self) -> BTreeSet<&'static str>

Return a clone of the set of names of synchronized values.

Mostly useful when we need to iterate over each value, while still maintaining a mutable reference of the surrounding SynchronizedParameters instance.

pub fn modified(&mut self) -> Vec<ModifiedParameter>

Return a vector of ModifiedParameter instances that need to be pushed to the backend and reset this set to the empty set for future calls.

The set will start growing again as soon as we modify a parameter from the synchronized set with a SynchronizedParameters::modify call.

pub fn get(&self, name: &str) -> String

Get the current in-memory value for the parameter identified by the given name.

Panics

The method will panic if the name does not refer to a valid parameter.

pub fn modify(&mut self, name: &str, value: &str) -> bool

Try to modify the in-memory entry for name in the SystemVars backing this SynchronizedParameters instace.

This will call SystemVars::reset iff value is the default for this name and SystemVars::set otherwise.

As a side effect, the modified set will be changed to contain name iff the in-memory entry for name was modified and name is in the synchronized set.

Return true iff the backing in-memory value for this name has changed.

pub fn enable_launchdarkly(&self) -> bool

Trait Implementations

impl Default for SynchronizedParameters

fn default() -> Self

Returns the “default value” for a type.