SUMMARY.md

The flow book

Intro

Introduction to flow

• Installing flow
• What is flow?
• Tenets of flow
• Project Components and Structure
• The Inspirations for flow
• Non-Inspirations
• Parallelism
• Status

Your First Flow

• Your First Flow
• Running the flow
• Step-by-Step
• Debugging your first flow

Defining Flows

• Defining flows
• Names
• Flow IOs
• Process References
• Function Definitions
• Data Types
• Connections
• Flow Libraries
• Context Functions
• Provided Functions
• Programming Methods

flowrcli's context functions

• flowr's context functions
• Arg functions
  • Arg get function
• File functions
  • File Write function
  • File Read function
• Image manipulation functions
  • Image buffer
• Standard IO functions
  • Readline function
  • Standard Input function
  • Standard Output function
  • Standard Error function

flowrgui's context functions

• flowrgui's context functions
• Arg functions
  • Arg get function
• File functions
  • File Write function
  • File Read function
• Image manipulation functions
  • Image buffer
• Standard IO functions
  • Readline function
  • Standard Input function
  • Standard Output function
  • Standard Error function

Running Flows

• Running flows
• flowc Command Line Arguments
• Passing command line arguments to flows
• Specifying the root file to load
• Standard Input and Output
• Exceptions and Panics
• Running Flows using flowr
• Running a flow in client/server mode of flowr
• Distributed execution of jobs with flowr and flowrex

Debugging Flows

• The Debugger

The flowstdlib Standard Library

• README
• control
  • compare_switch
  • index
  • index_f
  • join
  • route
  • select
  • tap
• data
  • accumulate
  • append
  • count
  • duplicate
  • enumerate
  • info
  • ordered_split
  • remove
  • sort
  • split
  • zip
• fmt
  • reverse
  • to_json
  • to_string
• math
  • add
  • compare
  • divide
  • multiply
  • range
  • range_split
  • sequence
  • sqrt
  • subtract
• matrix
  • duplicate_rows
  • multiply
  • multiply_row
  • transpose
  • compose_matrix

Examples flows

• Examples Intro
  • args
  • args-json
  • arrays
  • debug-help-string
  • debug-print-args
  • double-connection
  • factorial
  • fibonacci
  • hello-world
  • line-echo
  • mandlebrot
    • escapes provided function
    • pixel_to_point provided function
  • pipeline
  • prime
  • primitives
  • reverse-echo
  • router
  • sequence
  • sequence-of-sequences
  • tokenizer
  • two-destinations

---

Developing flow

• Developing flow
• Pre-requisites
• Building
• Crates
  • flowcore
  • flowmacro
    • flowc
      • Flowc Compiler and Parser Test flows
  • flowr
    • flowrlib
    • flowrex
    • flowstdlib
    • examples
• Makefile targets
• Ways to contribute
  • Issues
  • PRs
  • Developing an example
  • Continuous Integration Tests

Internals of the flow Project

• Internals of flow
  • Flow Loading
  • Flow Compiling
  • Flow Execution
  • Flow Execution State Transitions