Struct origen::STATUS

pub struct STATUS { /* fields omitted */ }

Provides status information derived from the runtime environment, e.g. if an app is present If an app is present then its Application struct is stored in here. Things like the current output and reference directories should be derived from here.

Methods from Deref<Target = Status>

pub fn register_custom_tester(&self, name: &str)

pub fn custom_tester_ids(&self) -> Vec<String>

pub fn generate_unique_id(&self) -> usize

Returns an ID that it guaranteed unique across threads and within the lifetime of an Origen invocation

pub fn push_testers_eq(&self, testers: Vec<SupportedTester>) -> OrigenResult<()>

Corresponds to the start of a tester specific block of code, returns an error if the given tester selection is not a subset of any existing selection

pub fn push_testers_neq(
    &self,
    testers: Vec<SupportedTester>
) -> OrigenResult<()>

Corresponds to the start of a tester except (tester not equal to) block of code, returns an error if the given tester selection is not valid within any existing eq or neq blocks

pub fn pop_testers_eq(&self) -> OrigenResult<()>

Corresponds to the end of a tester specific block, returns an error if no tester specific selection currently exists

pub fn pop_testers_neq(&self) -> OrigenResult<()>

Corresponds to the end of a tester exclusion block, returns an error if no tester exlcusion selection currently exists

pub fn unhandled_error_count(&self) -> usize

Returns the number of unhandled errors that have been encountered since this thread started. An example of a unhandled error is a pattern that failed to generate. If an error occurs on the Python side then Origen will most likely crash, however on the rust side it is possible to keep going (e.g. to the next pattern), and this keeps track of how many big problems there were for reporting to the user at the end.

pub fn inc_unhandled_error_count(&self)

pub fn set_debug_enabled(&self, val: bool)

pub fn is_debug_enabled(&self) -> bool

pub fn set_operation(&self, val: Operation)

pub fn operation(&self) -> Operation

pub fn set_cli_location(&self, loc: Option<String>)

pub fn set_cli_version(&self, ver: Option<String>)

pub fn cli_location(&self) -> Option<PathBuf>

pub fn cli_version(&self) -> Option<Version>

pub fn update_other_build_info(&self, key: &str, item: &str) -> OrigenResult<()>

pub fn other_build_info(&self) -> HashMap<String, String>

pub fn set_output_dir(&self, path: &Path)

Set the base output dir to the given path, it is /output by default

pub fn set_reference_dir(&self, path: &Path)

Set the base reference dir to the given path, it is /.ref by default

pub fn in_origen_core_app(&self) -> bool

pub fn set_in_origen_core_app(&self, stat: bool)

pub fn output_dir(&self) -> PathBuf

This is the main method to get the current output directory, accounting for all possible ways to set it, from current command, the app, default, etc. If nothing has been set (only possible when running globally), then it will default to the PWD. It will ensure that the directory exists before returning it.

pub fn with_output_dir<T, F>(&self, change_dir: bool, f: F) -> OrigenResult<T> where
    F: FnMut(&Path) -> OrigenResult<T>, 

Execute the given function with a reference to the current output directory (/output by default). Optionally, the current working directory can be switched to the output dir before executing the function and then restored at the end by setting change_to to True. If this is called when Origen is executing outside of an application workspace then it will return None unless it has been previously set by calling set_output_dir().

pub fn reference_dir(&self) -> Option<PathBuf>

This is the main method to get the current reference directory, accounting for all possible ways to set it, from current command, the app, default, etc. If nothing has been set (only possible when running globally), then it will return None. It will ensure that the directory exists before returning it.

pub fn with_reference_dir<T, F>(
    &self,
    change_dir: bool,
    f: F
) -> OrigenResult<T> where
    F: FnMut(Option<&PathBuf>) -> OrigenResult<T>, 

Execute the given function with a reference to the current reference directory (/.ref by default). Optionally, the current working directory can be switched to the reference dir before executing the function and then restored at the end by setting change_to to True. If this is called when Origen is executing outside of an application workspace then it will return None unless it has been previously set by calling set_reference_dir().

Trait Implementations

impl Deref for STATUS

type Target = Status

The resulting type after dereferencing.

fn deref(&self) -> &Status

Dereferences the value.

impl LazyStatic for STATUS

fn initialize(lazy: &Self)