Struct pir_8_emu::binutils::pir_8_emu::ExecutionConfig

pub struct ExecutionConfig {
    pub auto_load_next_instruction: bool,
    pub execute_full_instructions: bool,
    pub general_purpose_register_letters: [char; 8],
}

A configuration set, specifying various execution tunings

Fields

auto_load_next_instruction: bool

Automatically load the next instruction, silently performing the NEXT_INSTRUCTION microops

execute_full_instructions: bool

Whether to perform all of instructions' μOps at once

general_purpose_register_letters: [char; 8]

The register letters

Validated and optionally truncated/reset at load

Methods

impl ExecutionConfig

pub fn new() -> ExecutionConfig

Create a new default-initialised config

pub fn read_from_config_dir<P: Into<PathBuf>>(
    cfg_dir: P
) -> Result<Option<ExecutionConfig>, Result<IoError, TomlError>>

Read an execution config from file named "exec_cfg.toml" under the specified config directory

Returns Err(Ok(ioe)) if reading the file failed with ioe.
Returns Err(Err(te)) if parsing the read file failed with te.
Returns Ok(None) if the file didn't exist.
Returns Ok(Some(ec)), if the file was correctly read and parsed as TOML, the contents of ec start off as ExecutionConfig::new(), and are then updated with each valid key, this behaviour is consistent with the Deserialize implementation.

Examples

Given "$ROOT/exec_cfg.toml" containing:

execute_full_instructions = true
hewwo = "uWu"
general_purpose_register_letters = ['H', 'e', 'w', 'w', 'o', 'U', 'w', 'U']

The following holds:

let root = Path::new("$ROOT");
assert_eq!(ExecutionConfig::read_from_config_dir(root).unwrap(),
           Some(ExecutionConfig {
               execute_full_instructions: true,
               general_purpose_register_letters: ['H', 'e', 'w', 'w', 'o', 'U', 'w', 'U'],
               ..ExecutionConfig::new()
           }));

pub fn write_to_config_dir<P: Into<PathBuf>>(
    &self,
    cfg_dir: P
) -> Result<(), IoError>

Write this execution config to the file named "exec_cfg.toml" under the specified config directory

The specified config directory and all its ascendants will be created

Examples

let root = Path::new("$ROOT");
ExecutionConfig::new().write_to_config_dir(&root).unwrap();

assert_eq!(fs::read_to_string(root.join("exec_cfg.toml")).unwrap(),
           "auto_load_next_instruction = false\n\
            execute_full_instructions = false\n\
            general_purpose_register_letters = [\n\
            \x20   'F',\n\
            \x20   'S',\n\
            \x20   'X',\n\
            \x20   'Y',\n\
            \x20   'A',\n\
            \x20   'B',\n\
            \x20   'C',\n\
            \x20   'D',\n\
            ]\n");

Trait Implementations

impl Clone for ExecutionConfig

fn clone(&self) -> ExecutionConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ExecutionConfig

impl Debug for ExecutionConfig

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

Formats the value using the given formatter.

impl Default for ExecutionConfig

fn default() -> ExecutionConfig

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for ExecutionConfig

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for ExecutionConfig

impl Hash for ExecutionConfig

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for ExecutionConfig

fn cmp(&self, other: &ExecutionConfig) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ExecutionConfig> for ExecutionConfig

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

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

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

This method tests for !=.

impl PartialOrd<ExecutionConfig> for ExecutionConfig

fn partial_cmp(&self, other: &ExecutionConfig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ExecutionConfig) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ExecutionConfig) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ExecutionConfig) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ExecutionConfig) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ExecutionConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for ExecutionConfig

impl StructuralPartialEq for ExecutionConfig