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

//!
//! [<img alt="github" src="https://img.shields.io/badge/github-workflow--rs-8da0cb?style=for-the-badge&labelColor=555555&color=8da0cb&logo=github" height="20">](https://github.com/workflow-rs/workflow-rs)
//! [<img alt="crates.io" src="https://img.shields.io/crates/v/workflow-core.svg?maxAge=2592000&style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/workflow-core)
//! [<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-workflow--core-56c2a5?maxAge=2592000&style=for-the-badge&logo=docs.rs" height="20">](https://docs.rs/workflow-core)
//! <img alt="license" src="https://img.shields.io/crates/l/workflow-core.svg?maxAge=2592000&color=6ac&style=for-the-badge&logoColor=fff" height="20">
//! <img src="https://img.shields.io/badge/platform- native-informational?style=for-the-badge&color=50a0f0" height="20">
//! <img src="https://img.shields.io/badge/platform- wasm32/browser -informational?style=for-the-badge&color=50a0f0" height="20">
//! <img src="https://img.shields.io/badge/platform- wasm32/node.js -informational?style=for-the-badge&color=50a0f0" height="20">
//! <img src="https://img.shields.io/badge/platform- solana_os/ignored-informational?style=for-the-badge&color=777787" height="20">
//!
//! [`workflow_core`] is a part of the [`workflow-rs`](https://crates.io/workflow-rs)
//! framework, subset of which is designed to function uniformally across multiple
//! environments including native Rust, WASM-browser and Solana OS targets.
//!
//! This is a general-purpose crate that provides platform-uniform (native and WASM) abstractions for:
//! - async channels
//! - task spawn, sleep and interval functions
//! - random identifiers
//! - async-friendly and threadsafe event triggers
//! - time (Instant and Duration) as well as functions to obtain UNIX time (native and WASM)
//! - yield_executor() function to yield Rust executor to browser using `requestAnimationFrame()` (this prevents async Rust applications from locking down the Browser UX)
//! - runtime autodetection, allowing to identify the operating environmnet at runtime
//! - home and data folder access (useful when combined with `workflow_store` crate)

extern crate self as workflow_core;

pub mod abortable;
pub mod enums;
pub mod extensions;
pub mod prelude;
pub mod runtime;
pub mod sendable;
pub mod utils;

mod native;
mod wasm;

/// Seal macro that prevents acceidental modification of the enclosed source code
/// by hashing the source code and comparing it to the supplied hash.  If the code
/// is modified, the macro will fail to compile, and the developer will need to
/// change the hash value.  This is useful for locking down sensitive parts of the
/// code to prevent their accidental change.
pub use workflow_core_macros::seal;

cfg_if::cfg_if! {
    if #[cfg(not(target_os = "solana"))] {
        // Generic 8-byte identifier
        pub mod id;
        // task re-exports and shims
        pub mod task;
        // channel re-exports and shims
        pub mod channel;
        // async object lookup combinator
        pub mod lookup;

        // time functions and utilities
        pub mod time;

        // timeout function
        // pub mod timeout;

        // environment variable access (native and Node.js abstraction)
        pub mod env;

        // Directory access (home folder, data folder) (native and Node.js abstraction)
        pub mod dirs;

        /// Trigger crate re-exports and shims
        pub mod trigger;

        pub mod hex;

        /// Re-export of [`mod@cfg_if`] crate.
        pub use ::cfg_if::cfg_if;

        /// dynamically configured re-export of async_trait as workflow_async_trait
        /// that imposes `Send` restriction in native (non-WASM) and removes `Send`
        /// restriction in WASM builds.
        #[cfg(target_arch = "wasm32")]
        pub use workflow_async_trait::async_trait_without_send as workflow_async_trait;
        /// dynamically configured re-export of async_trait as workflow_async_trait
        /// that imposes `Send` restriction in native (non-WASM) and removes `Send`
        /// restriction in WASM builds.
        #[cfg(not(target_arch = "wasm32"))]
        pub use workflow_async_trait::async_trait_with_send as workflow_async_trait;

    }
}