Struct dqcsim::host::configuration::PluginProcessSpecification

pub struct PluginProcessSpecification {
    pub executable: PathBuf,
    pub script: Option<PathBuf>,
    pub typ: PluginType,
}

Plugin specification, consisting of the executable filename for the plugin and an optional script filename for it to execute for when the executable is an interpreter.

Fields

executable: PathBuf

The executable filename of the plugin.

script: Option<PathBuf>

If specified, the executable is expected to be an interpreter, which is to execute the specified script file. If not specified, the executable is a native plugin.

typ: PluginType

Plugin type.

Implementations

impl PluginProcessSpecification

pub fn new<T>(
    executable: impl Into<PathBuf>,
    script: Option<T>,
    typ: impl Into<PluginType>
) -> PluginProcessSpecification where
    T: Into<PathBuf>, 

Constructs a new plugin specification.

pub fn from_sugar(
    specification: impl Into<PathBuf>,
    typ: PluginType
) -> Result<PluginProcessSpecification>

Constructs a plugin specification from a "sugared" specification.

The specification can take the following forms:

• a valid path to a plugin executable with no file extension;
• the basename of a plugin executable with no file extension with implicit "dqcsfe"/"dqcsop"/"dqcsbe" prefix, searched for in A) the working directory, B) the binary directory, and C) the system $PATH;
• a valid path to a script file with a file extension. In this case, the above rule is run for a plugin named by the file extension of the script file. For instance, if "test.py" is specified for the frontend, this will look for an executable named "dqcsfepy".

Failure to find the plugin executable or script file results in an error being returned.

Trait Implementations

impl Clone for PluginProcessSpecification

fn clone(&self) -> PluginProcessSpecification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PluginProcessSpecification

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginProcessSpecification

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<PluginProcessSpecification> for PluginProcessSpecification

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for PluginProcessSpecification

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 PluginProcessSpecification