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

// Copyright 2021 Cargill Incorporated
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! # Augrim
//!
//! Augrim is a collection of reusable consensus algorithms.
//!
//! # Using Augrim's Algorithms
//!
//! To use an algorithm, your application will commonly need to do two primary things:
//!
//! - Input [`Events`] into the [`Algorithm::event`] method.
//! - Process the list of [`Actions`] returned by the [`Algorithm::event`] method.
//!
//! [`Actions`]: trait.Algorithm.html#associatedtype.Action
//! [`Events`]: trait.Algorithm.html#associatedtype.Event
//!
//! The specific actions and events differ by algorithm; refer to the algorithm's documentation.

#[macro_use]
extern crate log;

#[cfg(feature = "algorithm")]
mod algorithm;
pub mod error;
mod message;
mod process;
#[cfg(feature = "time")]
mod time;
#[cfg(feature = "algorithm-two-phase-commit")]
pub mod two_phase_commit;

#[cfg(feature = "algorithm")]
pub use algorithm::{Algorithm, IntoAlgorithm, Value};
pub use message::Message;
pub use process::Process;
#[cfg(feature = "time")]
pub use time::{SystemTimeFactory, Time, TimeSource};