workflow-rs Goto Github PK

WORKFLOW-RS project is designed to provide a unified environment for development of async Rust applications that are able to run in native platforms (desktops and servers), and WASM32 environments such as Web Browsers, Node.js NWJS (Node Webkit) and Electron.

• Platform neutral crates that are able to function in, or provide abstractions for, running on bare metal (native) as well as inside of a browser, Node.js or NWJS WASM-powered environments.
• BPF-friendly (Solana OS) environment that allows certain crates when building to the BPF targets.

This project is comprised of the following crates. These crates contain a carefully curated collection of functions and re-exports meant to provide a platform-neutral environment framework for Rust applications.

• workflow-dom - DOM utilities offering JavaScript injection functionality at runtime, allowing you to load JavaScript into the browser environment at Runtime using Rust. (This allows you to embed JavaScript modules directly into your Rust crates.
• workflow-websocket - WebSocket crate with async Rust API that functions uniformly in the native environemnt (using Tokio) and within a browser using the native browser WebSockets.
• workflow-rpc - RPC crate based on top of workflow-websocket that offers asynchronous Binary data relay over Workflow-WebSocket-based connections using Borsh serialization.
• workflow-core - Core utilities used by the Workflow framework. These utilities implement as well as re-export curated implementations that are compatible with async Rust environment requiring Send markers.
• workflow-log Logging functionality that is Native, WASM (browser) and BPF-friendly.
• workflow-wasm A set of WASM helper modules and utility functions for accessing JavaScript object properties.
• workflow-terminal A unified terminal implementation designed to offer a terminal user interface in a native shell (OS) as well as in-browser. This implementation is helpful for creating and testing crates that are meant to function in-browser and on native platforms.
• workflow-html HTML templating marco meant to offer an easy-to-use runtime html templating against DOM when using async Rust in-browser. This crate is a foundational pillar behind WORKFLOW-UX crate that offers Rust-based DOM-driven UX creation.
• workflow-i18n i18n framework for Workflow-UX Applications. This framework offers runtime translation of text based on a phrase-dictionary database.
• workflow-store A crate offering a simple platform-neutral file (data) storage but resolving file paths at runtime based on the OS as well as supporting browser local-storage.

Crates that are a part of this project but are currently outside of this repository:

• workflow-ux Async Rust + HTML Web Component driven application user interface library.

Examples for workflow-websocket, workflow-rpc and workflow-terminal are available in the /examples folder.

This project is under heavy development. Any contributions, ideas or feedback would be very welcome.