Struct ExecutionMask 

pub struct ExecutionMask(/* private fields */);

Execution options (ExecMask_*), the mask behind the Execution page of the Station Options dialog.

Each checkbox on that page is one bit here, so the mask is how a headless host configures debugging and tracing without a sequence editor.

Tracing has two independent controls, and confusing them is the usual mistake:

• Whether tracing happens, Self::TRACING_ENABLED plus the TRACE_INTO_* bits that widen its reach.
• How fast it runs, not in this mask at all. That is the Speed slider, which is StationOptions::ui_message_delay: milliseconds between trace postings. See that method for the scale.

use rs_teststand::ExecutionMask;

// Headless: keep tracing, drop everything that can stop an execution.
let unattended = ExecutionMask::DEFAULT.difference(
    ExecutionMask::BREAKPOINTS_ENABLED
        | ExecutionMask::BREAK_ON_RUN_TIME_ERROR
        | ExecutionMask::BREAK_WHILE_TERMINATING
        | ExecutionMask::ALLOW_BREAK_WHILE_IN_CODE_MODULES,
);
assert!(!unattended.contains(ExecutionMask::BREAKPOINTS_ENABLED));

Implementations

impl ExecutionMask

pub const BREAKPOINTS_ENABLED: Self

Breakpoints are honoured (ExecMask_BreakpointsEnabled).

A breakpoint suspends the execution until an operator resumes it, so this bit is the first to clear on an unattended station.

pub const BREAK_WHILE_TERMINATING: Self

Breakpoints are still honoured while terminating (ExecMask_BreakWhileTerminating).

pub const BREAK_ON_RUN_TIME_ERROR: Self

A run-time error breaks into the debugger (ExecMask_BreakOnRunTimeError).

Clear this on an unattended station and let StationOptions::set_rte_option decide what happens instead.

pub const TRACING_ENABLED: Self

Tracing is on (ExecMask_TracingEnabled).

pub const TRACE_INTO_SETUP_CLEANUP: Self

Trace into Setup and Cleanup step groups (ExecMask_TraceIntoSetupCleanup).

pub const TRACE_INTO_PRE_POST_CALLBACKS: Self

Trace into pre- and post-step callbacks (ExecMask_TraceIntoPrePostCallbacks).

pub const TRACE_INTO_POST_ACTION_CALLBACKS: Self

Trace into post-action callbacks (ExecMask_TraceIntoPostActionCallbacks).

pub const TRACE_INTO_SEPARATE_EXECUTION_CALLBACKS: Self

Trace into separate-execution callbacks (ExecMask_TraceIntoSeparateExecutionCallbacks).

pub const TRACE_INTO_ENTRY_POINTS: Self

Trace into entry points (ExecMask_TraceIntoEntryPoints).

pub const TRACE_INTO_SEQUENCE_CALLS_MARKED_AS_TRACE_OFF: Self

Trace into sequence calls whose tracing is switched off (ExecMask_TraceIntoSequenceCallsMarkedAsTraceOff).

pub const TRACE_WHILE_TERMINATING: Self

Keep tracing while an execution terminates (ExecMask_TraceWhileTerminating).

pub const TRACE_ALL_THREADS: Self

Trace every thread (ExecMask_TraceAllThreads).

The most expensive tracing bit on a parallel station: every thread posts trace messages, and each posting is paced by the Speed setting.

pub const INTERACTIVE_RECORD_RESULTS: Self

Interactive executions record results (ExecMask_InteractiveRecordResults).

pub const INTERACTIVE_RUN_SETUP_CLEANUP: Self

Interactive executions run Setup and Cleanup (ExecMask_InteractiveRunSetupCleanup).

pub const INTERACTIVE_EVALUATE_PRECONDITIONS: Self

Interactive executions evaluate preconditions (ExecMask_InteractiveEvaluatePreconditions).

pub const ALLOW_BREAK_WHILE_IN_CODE_MODULES: Self

Allow breaking while inside a code module (ExecMask_AllowBreakWhileInCodeModules).

pub const DEFAULT: Self

The engine’s default combination (ExecMask_DefaultExecutionMask).

32797 = breakpoints + run-time-error break + tracing + trace into setup/cleanup + break inside code modules.

pub const BREAKS: Self

Every bit that breaks into the debugger.

Not an engine constant: the union this crate treats as unsafe for an unattended host: each one suspends the execution until an operator acts.

impl ExecutionMask

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> i32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: i32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: i32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: i32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in self are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in other are also set in self.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in other are also set in self.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

pub fn remove(&mut self, other: Self)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in self and other.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in self and other.

pub const fn difference(self, other: Self) -> Self

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in self and other.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl ExecutionMask

pub const fn iter(&self) -> Iter<ExecutionMask>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<ExecutionMask>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for ExecutionMask

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

Formats the value using the given formatter.

impl BitAnd for ExecutionMask

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

The bitwise and (&) of the bits in self and other.

type Output = ExecutionMask

The resulting type after applying the & operator.

impl BitAndAssign for ExecutionMask

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in self and other.

impl BitOr for ExecutionMask

fn bitor(self, other: ExecutionMask) -> Self

The bitwise or (|) of the bits in self and other.

type Output = ExecutionMask

The resulting type after applying the | operator.

impl BitOrAssign for ExecutionMask

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in self and other.

impl BitXor for ExecutionMask

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

The bitwise exclusive-or (^) of the bits in self and other.

type Output = ExecutionMask

The resulting type after applying the ^ operator.

impl BitXorAssign for ExecutionMask

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in self and other.

impl Clone for ExecutionMask

fn clone(&self) -> ExecutionMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ExecutionMask

impl Debug for ExecutionMask

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

Formats the value using the given formatter.

impl Default for ExecutionMask

fn default() -> ExecutionMask

Returns the “default value” for a type.

impl Eq for ExecutionMask

impl Extend<ExecutionMask> for ExecutionMask

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Flags for ExecutionMask

const FLAGS: &'static [Flag<ExecutionMask>]

The set of defined flags.

type Bits = i32

The underlying bits type.

fn bits(&self) -> i32

Get the underlying bits value.

fn from_bits_retain(bits: i32) -> ExecutionMask

Convert from a bits value exactly.

fn all_named() -> ExecutionMask

Get a flags value with all bits from named flags set.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn known_bits(&self) -> Self::Bits

Get the known bits from a flags value.

fn unknown_bits(&self) -> Self::Bits

Get the unknown bits from a flags value.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn iter_equal_names(&self) -> IterEqualNames<Self>

Get an iterator over all defined names for this flags value.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in other are also set in self.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in other are also set in self.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in self and other.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of self with the complement of other (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in self and other.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

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

The bitwise and (&) of the bits in self and other.

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

The bitwise or (|) of the bits in self and other.

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

The intersection of self with the complement of other (&!).

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

The bitwise exclusive-or (^) of the bits in self and other.

fn complement(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

impl FromIterator<ExecutionMask> for ExecutionMask

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for ExecutionMask

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for ExecutionMask

type Item = ExecutionMask

The type of the elements being iterated over.

type IntoIter = Iter<ExecutionMask>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for ExecutionMask

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

Formats the value using the given formatter.

impl Not for ExecutionMask

fn not(self) -> Self

The bitwise negation (!) of the bits in self, truncating the result.

type Output = ExecutionMask

The resulting type after applying the ! operator.

impl Octal for ExecutionMask

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

Formats the value using the given formatter.

impl PartialEq for ExecutionMask

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

Equality operator ==.

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

Inequality operator !=.

impl PublicFlags for ExecutionMask

type Primitive = i32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl StructuralPartialEq for ExecutionMask

impl Sub for ExecutionMask

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

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = ExecutionMask

The resulting type after applying the - operator.

impl SubAssign for ExecutionMask

fn sub_assign(&mut self, other: Self)

The intersection of self with the complement of other (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for ExecutionMask

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

Formats the value using the given formatter.