Struct dqcsim::host::configuration::PluginThreadConfiguration

pub struct PluginThreadConfiguration {
    pub closure: PluginThreadClosure,
    pub plugin_type: PluginType,
    pub init_cmds: Vec<ArbCmd>,
    pub log_configuration: PluginLogConfiguration,
}

Represents the complete configuration for a plugin running in a local thread.

Fields

closure: PluginThreadClosure

The closure that's called from within the plugin thread. It is responsible for calling PluginState::run() in one way or another.

plugin_type: PluginType

The type of plugin that the closure is expected to start.

init_cmds: Vec<ArbCmd>

The vector of ArbCmds passed to the initialize() closure.

This is mostly useless since you can also just move data directly into the closures prior to plugin construction. Therefore it is not part of the constructor function. It is mostly just left here for uniformity with the external process method of constructing a plugin.

log_configuration: PluginLogConfiguration

Configuration for the logging subsystem of the plugin.

Methods

impl PluginThreadConfiguration

pub fn new(
    definition: PluginDefinition,
    log_configuration: PluginLogConfiguration
) -> PluginThreadConfiguration

Creates a new plugin configuration.

The default values are inserted for the configuration options.

pub fn new_raw(
    closure: PluginThreadClosure,
    plugin_type: PluginType,
    log_configuration: PluginLogConfiguration
) -> PluginThreadConfiguration

Creates a new plugin through a custom closure.

The default values are inserted for the configuration options.

pub fn with_init_cmd(self, cmd: impl Into<ArbCmd>) -> PluginThreadConfiguration

Adds an init cmd to the list, builder style.

Trait Implementations

impl PluginConfiguration for PluginThreadConfiguration

fn instantiate(self: Box<Self>) -> Box<dyn Plugin>

Instantiates the plugin.

fn get_log_configuration(&self) -> PluginLogConfiguration

Returns the log configuratin of the plugin. Note that this returns a copy!

fn get_type(&self) -> PluginType

Returns the plugin type.

fn get_reproduction(
    &self,
    _: ReproductionPathStyle
) -> Result<PluginReproduction>

Returns the PluginReproduction when possible. Otherwise return an error.

fn limit_verbosity(&mut self, max_verbosity: LoglevelFilter)

Limits the verbosity of the messages reported to the simulator.

fn set_default_name(&mut self, default_name: String)

Sets the default name for this plugin.

impl Into<Box<dyn PluginConfiguration + 'static>> for PluginThreadConfiguration

fn into(self) -> Box<dyn PluginConfiguration>

Performs the conversion.

impl Debug for PluginThreadConfiguration

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.