Struct MachineId

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

An opaque token representing one machine running inside the framework. Values are guaranteed to be in the range 0..Framework::num_machines, so raw values using MachineId::into_raw are suitable for indexing a slice of of at least Framework::num_machines elements. This is handy for framework integration and keeping associated state with a performance focus, but care must be taken to avoid out-of-bounds accesses (i.e., not very Rust idiomatic).

Implementations

impl MachineId

pub fn from_raw(raw: usize) -> Self

Create a new machine identifier from a raw integer. Intended for use with the machine field of TriggerAction and TriggerEvent. For testing and FFI-wrapper purposes only. For regular use, use MachineId returned by Framework::trigger_events. Triggering an event in the framework for a machine that does not exist does not raise a panic or any error.

pub fn into_raw(self) -> usize

Return the raw integer representation of the machine identifier. For testing and FFI-wrapper purposes only. For regular use, use the MachineId returned by Framework::trigger_events.

Trait Implementations

impl Clone for MachineId

fn clone(&self) -> MachineId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MachineId

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

Formats the value using the given formatter.

impl Hash for MachineId

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 PartialEq for MachineId

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

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

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 Copy for MachineId

impl Eq for MachineId

impl StructuralPartialEq for MachineId