phoxal 0.23.0

Phoxal - production-oriented autonomous robot framework: the runtime engine and model (the api contract tree lives in phoxal-api, the typed bus in phoxal-bus).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

//! The participant engine: static metadata traits, contexts, clock, launch contract,
//! `emit-apis`, and the runner.
//!
//! Authoring uses `#[derive(phoxal::Service)]`, `#[derive(phoxal::Driver)]`,
//! `#[derive(phoxal::Tool)]`, or `#[derive(phoxal::Simulator)]` with
//! `#[phoxal::behavior]` (see the crate docs); this module is the
//! runner-facing machinery those macros target.

mod bus_log;
pub mod clock;
pub mod context;
pub mod emit;
pub mod launch;
pub(crate) mod runner;
mod sd_notify;
pub mod server;
pub mod spec;

pub use clock::{ClockSource, RealClock, TestClock};
pub use context::{SetupContext, ShutdownContext, StepContext, SubscribeBuilder, SubscribeOptions};
pub use emit::{ParticipantMetadata, emit_apis_json, participant_metadata};
pub use launch::{BusProfile, ClockMode, ParticipantLaunch};
pub use runner::{run, run_async, run_with};
pub use server::{ServerOutcome, ServerReply, Snapshot};
pub use spec::{
    ContractUse, DeclaresPublish, DeclaresQuery, DeclaresSubscribe, Direction, IsDriver,
    IsSimulator, IsTool, MissedTick, ParticipantBehavior, ParticipantSpec, StepSchedule,
};

/// Re-exported so authoring code can name logical time without reaching into
/// `bus` (the prelude re-exports this).
pub use crate::bus::LogicalTime;

#[cfg(test)]
mod tests;