flowstdlib 1.0.0

The standard library of functions and flows for 'flow' programs
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

#![deny(clippy::unwrap_used, clippy::expect_used)]
//! `flowstdlib` is a library of flows and functions that can be used from flows.
//!
//! The flow and function definition are used at compile time when compile flows that reference
//! it.
//!
//! At run-time, library entries can be of two types, indicated by their
//! `ImplementationLocator``flowcore::model::lib_manifest::ImplementationLocator`
//!
//! - [Native][flowcore::model::lib_manifest::ImplementationLocator::Native] - a native binary
//!   containing all functions is built and linked by a flow runner program (e.g. `flowr`) so that
//!   any function referenced by a flow is executed natively at native speeds. `flowr` offers the
//!   user control using this via the `-n, --native` command line option.
//!
//! - `RelativePath``flowcore::model::lib_manifest::ImplementationLocator::RelativePath` - functions
//!   are compiled to WASM files and located within the library at runtime by the flow runner using
//!   this file path relative to the lib root. If either the library if not linked natively, or the
//!   `-n, --native` command line option is not used, when the function is referenced by a flow
//!   being run, it is loaded and executed in a WASM runtime.

/// Functions for generating charts and visualizations from data.
pub mod charts;

/// Functions and flows to control the flow of data in a flow based on control inputs.
pub mod control;

/// Some generic processes that act on data.
pub mod data;

/// Math Functions and flows
pub mod math;

/// Matrix functions and flows
pub mod matrix;

/// Functions for the formatting of values and conversion from one type to another.
pub mod fmt;

/// Use `manifest::get` to get the natively/statically linked
/// `LibraryManifest``flowcore::model::lib_manifest::LibraryManifest` for this library
/// to get access to everything `error_chain` creates.
pub mod manifest;

/// provides [Error][errors::Error] that other modules in this crate will `use errors::*;`
pub mod errors;

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::expect_used)]
#[allow(clippy::missing_panics_doc)]
#[allow(missing_docs)]
pub mod test {
    use std::path::Path;
    use std::process::{Command, Stdio};

    #[must_use]
    pub fn execute_flow(filepath: &Path) -> String {
        let command_args = vec![
            "-r",
            "flowrcli",
            filepath
                .to_str()
                .expect("Couldn't convert file path to string"),
        ];

        // spawn the 'flowc' child process
        let runner = Command::new("flowc")
            .args(command_args)
            .stdin(Stdio::inherit())
            .stdout(Stdio::piped())
            .stderr(Stdio::inherit())
            .spawn()
            .expect("Couldn't spawn flowc to run test flow");

        // Use wait_with_output to read stdout concurrently with waiting,
        // avoiding a pipe deadlock when the child's stdout buffer fills up.
        let result = runner.wait_with_output().expect("failed to wait on child");

        assert!(result.status.success());
        String::from_utf8(result.stdout).expect("stdout was not valid UTF-8")
    }
}