ebi_bpmn 0.0.46

A BPMN parser, writer and executor
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

//! A BPMN crate written in pure Rust
//!
//! Contains a parser, a data structure and a writer.
//! For now, this crate focuses on the behaviour of BPMN models; not on the data or resource perspectives.
//! The crate provides methods to parse BPMN models, methods to write BPMN models, and methods to traverse the state space of a BPMN model.
//!
//! A web-based tool to create BPMN models is [bpmn.io].
//!
//! This create is intended as a crate to be used in other software. If you are an end user, please consider using the [Ebi] crate & tool, which provides user-accessible algorithms that use BPMN.
//!
//! # Usage
//!
//! The main struct is [BusinessProcessModelAndNotation], which contains methods for parsing, writing and state-space traversal.
//! To create a BPMN model programmatically, consider the [BPMNCreator] struct.
//!
//! To parse a BPMN model:
//!  ```
//!  use std::io::prelude::*;
//!  use std::io::BufReader;
//!  use std::fs::File;
//!  use ebi_bpmn::BusinessProcessModelAndNotation;
//!  
//!  fn main() -> anyhow::Result<()> {
//!   let f = File::open("testfiles/model.bpmn")?;
//!   let mut reader = BufReader::new(f);
//!  
//!   let bpmn = BusinessProcessModelAndNotation::import_from_reader(&mut reader, true)?;
//!  
//!   let mut marking = bpmn.get_initial_marking()?.unwrap();
//!   assert_eq!(bpmn.get_enabled_transitions(&marking)?, vec![0]);
//!   bpmn.execute_transition(&mut marking, 0)?;
//!  
//!   Ok(())
//!  }
//!  ```
//!
//! [Ebi]: https://crates.io/crates/ebi
//! [bpmn.io]: https://bpmn.io

pub(crate) mod business_process_model_and_notation;
pub(crate) mod conversion;
pub(crate) mod creator;
pub mod element;
pub mod elements {
    pub mod collapsed_pool;
    pub mod collapsed_sub_process;
    pub mod end_event;
    pub mod event_based_gateway;
    pub mod exclusive_gateway;
    pub mod expanded_sub_process;
    pub mod inclusive_gateway;
    pub mod intermediate_catch_event;
    pub mod intermediate_throw_event;
    pub mod manual_task;
    pub mod message_end_event;
    pub mod message_intermediate_catch_event;
    pub mod message_intermediate_throw_event;
    pub mod message_start_event;
    pub mod parallel_gateway;
    pub mod process;
    pub mod receive_task;
    pub mod start_event;
    pub mod task;
    pub mod timer_intermediate_catch_event;
    pub mod timer_start_event;
    pub mod user_task;
}
pub(crate) mod exporter;
pub(crate) mod if_not;
pub(crate) mod importer;
pub(crate) mod marking;
pub(crate) mod message_flow;
pub(crate) mod semantics;
pub(crate) mod sequence_flow;
pub(crate) mod structure_checker;
pub(crate) mod parser {
    pub mod parser;
    pub mod parser_state;
    pub mod parser_traits;
    pub mod tag_collaboration;
    pub mod tag_definitions;
    pub mod tag_end_event;
    pub mod tag_event_based_gateway;
    pub mod tag_exclusive_gateway;
    pub mod tag_inclusive_gateway;
    pub mod tag_intermediate_catch_event;
    pub mod tag_intermediate_throw_event;
    pub mod tag_manual_task;
    pub mod tag_message_event_definition;
    pub mod tag_message_flow;
    pub mod tag_parallel_gateway;
    pub mod tag_participant;
    pub mod tag_process;
    pub mod tag_receive_task;
    pub mod tag_sequence_flow;
    pub mod tag_start_event;
    pub mod tag_subprocess;
    pub mod tag_task;
    pub mod tag_timer_event_definition;
    pub mod tag_user_task;
    pub mod tag_weight;
    pub mod tags;
}
pub mod partially_ordered_run;
pub(crate) mod stochastic_business_process_model_and_notation;
pub mod traits {
    pub mod objectable;
    pub mod processable;
    pub mod searchable;
    pub mod startable;
    pub mod transitionable;
    pub mod writable;
}
pub(crate) mod writer {
    pub mod collapsed_pool;
    pub mod collapsed_sub_process;
    pub mod end_event;
    pub mod event_based_gateway;
    pub mod exclusive_gateway;
    pub mod expanded_sub_process;
    pub mod inclusive_gateway;
    pub mod intermediate_catch_event;
    pub mod intermediate_throw_event;
    pub mod manual_task;
    pub mod message_end_event;
    pub mod message_flow;
    pub mod message_intermediate_catch_event;
    pub mod message_intermediate_throw_event;
    pub mod message_start_event;
    pub mod parallel_gateway;
    pub mod process;
    pub mod receive_task;
    pub mod sequence_flow;
    pub mod start_event;
    pub mod task;
    pub mod timer_intermediate_catch_event;
    pub mod timer_start_event;
    pub mod user_task;
}

pub use business_process_model_and_notation::BusinessProcessModelAndNotation;
pub use creator::BPMNCreator;
pub use creator::Container;
pub use creator::EndEventType;
pub use creator::GatewayType;
pub use creator::IntermediateEventType;
pub use creator::StartEventType;
pub use marking::BPMNMarking;
pub use marking::Token;
pub use message_flow::BPMNMessageFlow;
pub use parser::parser_state::GlobalIndex;
pub use sequence_flow::BPMNSequenceFlow;
pub use stochastic_business_process_model_and_notation::StochasticBusinessProcessModelAndNotation;