Enum timely_communication::initialize::Config

pub enum Config {
    Thread,
    Process(usize),
    ProcessBinary(usize),
    Cluster {
        threads: usize,
        process: usize,
        addresses: Vec<String>,
        report: bool,
        log_fn: Arc<dyn Fn(CommunicationSetup) -> Option<Logger<CommunicationEvent>> + Send + Sync>,
    },
}

Possible configurations for the communication infrastructure.

Variants

Thread

Use one thread.

Process(usize)

Use one process with an indicated number of threads.

ProcessBinary(usize)

Use one process with an indicated number of threads. Use zero-copy exchange channels.

Cluster

Expect multiple processes.

Fields

threads: usize

Number of per-process worker threads

process: usize

Identity of this process

addresses: Vec<String>

Addresses of all processes

report: bool

Verbosely report connection process

log_fn: Arc<dyn Fn(CommunicationSetup) -> Option<Logger<CommunicationEvent>> + Send + Sync>

Closure to create a new logger for a communication thread

Implementations

impl Config

pub fn install_options(opts: &mut Options)

Installs options into a getopts::Options struct that corresponds 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 from_args<I: Iterator<Item = String>>(args: I) -> Result<Config, String>

Constructs a new configuration by parsing the supplied text arguments.

Most commonly, callers supply std::env::args() as the iterator.

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

pub fn try_build( self, ) -> Result<(Vec<GenericBuilder>, Box<dyn Any + Send>), String>

Attempts to assemble the described communication infrastructure.

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.