automation-structures 0.1.0

Reusable, formally specified building blocks for composing automation systems.
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

//! Verified Rust objects for composing automation structures.
//!
//! The checked root API is intended for ordinary consumers. The catalog modules
//! retain the proof-oriented carriers used by the formal correspondence suite.
//!
//! # Example
//!
//! ```rust
//! use automation_structures::Budget;
//!
//! let mut budget = Budget::new(8);
//! assert!(budget.try_reserve(3));
//! budget.commit_reservation(3)?;
//! assert_eq!(budget.available(), 5);
//! # Ok::<(), automation_structures::BudgetError>(())
//! ```

#![deny(missing_docs)]

mod api;
mod composition_api;
#[allow(dead_code, missing_docs)]
mod compositions;
mod connective_api;
#[allow(dead_code, missing_docs)]
mod connectives;
mod execution_api;
#[allow(dead_code, missing_docs)]
mod integration;
#[allow(dead_code, missing_docs)]
mod modalities;
#[allow(dead_code, missing_docs)]
mod primitives;

pub use api::{
    ActuationError, ActuationPass, AuditRecord, AuditSink, BacktrackingBuildError,
    BacktrackingError, BacktrackingTraversal, Budget, BudgetError, CompetitiveSelectionError,
    CompetitiveSelectionHard, CompetitiveSelectionHardExclusive, CompetitiveSelectionRanked,
    CompetitiveSelectionSoft, ConvergenceBuildError, ConvergenceError, ConvergenceGovernor,
    ConvergencePhase, ConvergenceState, Cursor, CursorError, PropagationBuildError,
    PropagationError, PropagationPass, PropagationRound, QualityHierarchy, QualityHierarchyError,
    ResourceRegistry,
};
pub use composition_api::{
    AllocationSnapshot, AllocationSnapshotError, Bisection, BisectionBuildError, BisectionError,
    EquivalenceClass, EquivalenceClassError, FederatedBudget, RateLimit, RateLimitBuildError,
    RateLimitError, Reduction, ReductionBuildError, ReductionError, RelationshipGraph,
    RelationshipGraphError, Sampler, SamplerError, Signal, SignalBuildError, SignalError,
    TraversalBuildError, TraversalEngine, TraversalError,
};
pub use connective_api::{
    Accumulator, Buffer, Counter, Marker, projection_consistent, strictly_before,
};
pub use execution_api::{
    ForkJoin, ForkJoinBuildError, ForkJoinPhase, Sequential, SequentialBuildError, StepGraph,
    StepGraphBuildError, StepState, StreamGraph, StreamGraphBuildError, WorkerState,
};