hydrologic.md

Module hydrologic

• Data Types
• Function Index
• Function Details

Data Types

data()

data() = any()

operation()

operation() = term()

pipe()

pipe() = atom()

reduct()

reduct() = '__empty__' | data() | {data(), any()} | {'__end__', any()}

Function Index

flow/2	Equivalent to run(Pipe, Data).
new/2	Create a new pipe.
run/2	Execute a pipe treatment.
stop/1	Destroy the given pipe.

Function Details

flow/2

flow(Pipe, Data) -> any()

Equivalent to run(Pipe, Data).

new/2

new(Name::atom(), Operations::[operation()]) -> pipe()

Create a new pipe.

run/2

run(Pipe::pipe(), Data::data()) -> {ok, data()} | {error, term(), data()} | {error, term()} | any()

Execute a pipe treatment.

stop/1

stop(Pipe::pipe()) -> ok | {error, term()}

Destroy the given pipe.