Skip to main content

Engine

Struct Engine 

Source
pub struct Engine {
    pub defs: BTreeMap<(String, i64), Machine>,
    pub latest: BTreeMap<String, i64>,
    pub instances: BTreeMap<InstanceId, Instance>,
    pub clock: u64,
    pub mode: Mode,
    pub observer: Option<Box<dyn FnMut(&StepRecord) + Send>>,
    /* private fields */
}

Fields§

§defs: BTreeMap<(String, i64), Machine>§latest: BTreeMap<String, i64>§instances: BTreeMap<InstanceId, Instance>§clock: u64§mode: Mode§observer: Option<Box<dyn FnMut(&StepRecord) + Send>>

Implementations§

Source§

impl Engine

Source

pub fn new() -> Self

Source

pub fn set_observer<F: FnMut(&StepRecord) + Send + 'static>(&mut self, f: F)

Source

pub fn register(&mut self, m: Machine)

Source

pub fn def( &self, id: &str, version: Option<i64>, ) -> Result<&Machine, EngineError>

Source

pub fn create_root( &mut self, id: &str, def_id: &str, version: Option<i64>, external: &BTreeMap<String, Value>, ) -> Result<(), EngineError>

Source

pub fn instance(&self, id: &str) -> Result<&Instance, EngineError>

Source

pub fn validate_event( &self, inst_id: &str, etype: &str, payload: &Value, ) -> Result<(), String>

Source

pub fn inject( &mut self, inst_id: &str, etype: &str, payload: Value, ) -> Result<bool, EngineError>

Source

pub fn send( &mut self, inst_id: &str, etype: &str, payload: Value, ) -> Result<RunResult, EngineError>

Source

pub fn advance(&mut self, duration_ms: u64) -> Result<RunResult, EngineError>

Source

pub fn step( &mut self, inst_id: &str, n: usize, ) -> Result<Vec<StepRecord>, EngineError>

Source

pub fn env_change( &mut self, inst_id: &str, changed: BTreeMap<String, Value>, ) -> Result<RunResult, EngineError>

Source

pub fn set_mode(&mut self, mode: Mode)

Source

pub fn get_mode(&self) -> Mode

Source

pub fn migrate_quiescent(&mut self) -> Result<(), EngineError>

Migrate eligible quiescent instances to a newer registered version (SPEC §10.2).

Source

pub fn state_view(&self, inst_id: &str) -> Result<StateView, EngineError>

Source

pub fn list_view(&self) -> Vec<ListView>

Source

pub fn inspect_view(&self, inst_id: &str) -> Result<InspectView, EngineError>

Source

pub fn enabled_events(&self, inst_id: &str) -> Result<Vec<String>, EngineError>

enabled_events(instance) — sorted declared event types the current active configuration can handle (SPEC §14).

Source

pub fn snapshot(&self, inst_id: &str) -> Result<Snapshot, EngineError>

Source

pub fn restore(&mut self, snap: Snapshot) -> Result<(), EngineError>

Trait Implementations§

Source§

impl Default for Engine

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Engine

§

impl !Sync for Engine

§

impl !UnwindSafe for Engine

§

impl Freeze for Engine

§

impl Send for Engine

§

impl Unpin for Engine

§

impl UnsafeUnpin for Engine

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AnyExt for T
where T: Any + ?Sized,

Source§

fn downcast_ref<T>(this: &Self) -> Option<&T>
where T: Any,

Attempts to downcast this to T behind reference
Source§

fn downcast_mut<T>(this: &mut Self) -> Option<&mut T>
where T: Any,

Attempts to downcast this to T behind mutable reference
Source§

fn downcast_rc<T>(this: Rc<Self>) -> Result<Rc<T>, Rc<Self>>
where T: Any,

Attempts to downcast this to T behind Rc pointer
Source§

fn downcast_arc<T>(this: Arc<Self>) -> Result<Arc<T>, Arc<Self>>
where T: Any,

Attempts to downcast this to T behind Arc pointer
Source§

fn downcast_box<T>(this: Box<Self>) -> Result<Box<T>, Box<Self>>
where T: Any,

Attempts to downcast this to T behind Box pointer
Source§

fn downcast_move<T>(this: Self) -> Option<T>
where T: Any, Self: Sized,

Attempts to downcast owned Self to T, useful only in generic context as a workaround for specialization
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T, X> CoerceTo<T> for X
where T: CoerceFrom<X> + ?Sized,

Source§

fn coerce_rc_to(self: Rc<X>) -> Rc<T>

Source§

fn coerce_box_to(self: Box<X>) -> Box<T>

Source§

fn coerce_ref_to(&self) -> &T

Source§

fn coerce_mut_to(&mut self) -> &mut T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.