flowrlib 0.8.3

The runtime library for executing 'flow' programs compiled with the 'flowc' compiler
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

// TODO #![deny(missing_docs)]
//! Runtime library for flow execution. This will be linked with other code to produce a flow runtime
//! or runner, such as `flowr` command line runner.
//!
//! It is responsible for reading a flow definition in a `Manifest` file, loading the required
//! libraries from `LibraryManifest` files and then coordinating the execution by dispatching `Jobs`
//! to be executed by `Function` `Implementations`, providing them the `Inputs` required to run and
//! gathering the `Outputs` produced and passing those `Outputs` to other connected `Functions` in
//! the network of `Functions`.
//!
#[macro_use]
extern crate error_chain;

/// `info` offers methods to get information about this library
pub mod info;
/// `coordinator` is the module that coordinates the execution of flows submitted to it
pub mod coordinator;
/// `lib_manifest` defines the structs for specifying a Library's manifest and methods to load it
pub mod lib_manifest;
/// `function` defines functions that form part of a flow
pub mod function;
/// `manifest` is the struct that specifies the manifest of functions in a flow
pub mod manifest;
/// `input` defines the struct for inputs to functions in a flow
pub mod input;
/// `loader` is responsible for loading a flow from it's manifest and loading libraries it uses
pub mod loader;
/// `provider` is a trait that is implemented to provide content to flowrlib in different environments
/// it runs in
pub mod provider;
/// A module with some utility functions related to urls
pub mod url;

#[cfg(feature = "debugger")]
/// 'debug_client' is used to connect a debugger to the runtime for debugging of flows
/// and is an optional feature called "debugger"
pub mod debug_client;

/// We'll put our errors in an `errors` module, and other modules in this crate will `use errors::*;`
/// to get access to everything `error_chain!` creates.
#[doc(hidden)]
pub mod errors {
    // Create the Error, ErrorKind, ResultExt, and Result types
    error_chain! {}
}

#[cfg(feature = "debugger")]
mod debugger;
mod execution;
mod wasm;
mod run_state;

#[cfg(feature = "metrics")]
mod metrics;

// Specify the errors we will produce and foreign links
error_chain! {
    types {
        Error, ErrorKind, ResultExt, Result;
    }

    foreign_links {
        Io(std::io::Error);
        Serde(serde_json::error::Error);
        Recv(std::sync::mpsc::RecvError);
    }
}