Struct EngineSignalSet

pub struct EngineSignalSet { /* private fields */ }

Struct to identify which EngineSignals were triggered during the submission of multiple commands to the engine (usually in execute_rpn_data)

Implementations

impl EngineSignalSet

pub fn new() -> Self

Creates a new EngineSignalSet with default values.

pub fn merge(&mut self, action: Result<EngineSignal, String>)

Given a result of an action, merge it into the set. This is a convinience method to easily set fields if the client should get a data structure from the engine.

Arguments

• action - The action to merge into the set

pub fn set_error(&mut self, error: &(impl ToString + ?Sized)) -> Self

Set an error in the signal set and return a new EngineSignalSet

pub fn stack_updated(&self) -> bool

Returns true if the stack was updated.

pub fn should_quit(&self) -> bool

Returns true if a quit signal was triggered.

pub fn get_error(&self) -> Option<String>

Get the last encountered error, if available

Trait Implementations

impl Clone for EngineSignalSet

fn clone(&self) -> EngineSignalSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EngineSignalSet

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

Formats the value using the given formatter.

impl Default for EngineSignalSet

fn default() -> EngineSignalSet

Returns the “default value” for a type.

impl Hash for EngineSignalSet

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 Ord for EngineSignalSet

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for EngineSignalSet

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for EngineSignalSet

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for EngineSignalSet

impl StructuralPartialEq for EngineSignalSet