Struct Config

pub struct Config { /* private fields */ }

Worker configuration.

Implementations

impl Config

pub fn install_options(opts: &mut Options)

Installs options into a getopts::Options struct that correspond to the parameters in the configuration.

It is the caller’s responsibility to ensure that the installed options do not conflict with any other options that may exist in opts, or that may be installed into opts in the future.

This method is only available if the getopts feature is enabled, which it is by default.

pub fn from_matches(matches: &Matches) -> Result<Config, String>

Instantiates a configuration based upon the parsed options in matches.

The matches object must have been constructed from a getopts::Options which contained at least the options installed by Self::install_options.

This method is only available if the getopts feature is enabled, which it is by default.

pub fn progress_mode(self, progress_mode: ProgressMode) -> Self

Sets the progress mode to progress_mode.

pub fn set<T>(&mut self, key: String, val: T) -> &mut Self

where T: Send + Sync + 'static,

Sets a typed configuration parameter for the given key.

It is recommended to install a single configuration struct using a key that uniquely identifies your project, to avoid clashes. For example, differential dataflow registers a configuration struct under the key “differential”.

Examples

let mut config = timely::Config::process(3);
config.worker.set("example".to_string(), 7u64);
timely::execute(config, |worker| {
   use crate::timely::worker::AsWorker;
   assert_eq!(worker.config().get::<u64>("example"), Some(&7));
}).unwrap();

pub fn get<T: 'static>(&self, key: &str) -> Option<&T>

Gets the value for configured parameter key.

Returns None if key has not previously been set with Config::set, or if the specified T does not match the T from the call to set.

Examples

let mut config = timely::Config::process(3);
config.worker.set("example".to_string(), 7u64);
timely::execute(config, |worker| {
   use crate::timely::worker::AsWorker;
   assert_eq!(worker.config().get::<u64>("example"), Some(&7));
}).unwrap();

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate 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.