reactor
▼
Project version
v0.15.2
v0.15.1
v0.15.0
v0.14.0
v0.13.3
v0.13.2
v0.13.1
v0.13.0
v0.12.1
v0.12.0
v0.11.0
v0.10.3
v0.10.2
v0.10.1
v0.10.0
v0.9.1
v0.9.0
v0.8.5
v0.8.4
v0.8.3
v0.8.2
v0.8.1
v0.8.0
v0.7.0
v0.6.0
v0.5.2
v0.5.1
v0.5.0
v0.4.1
v0.4.0
v0.3.5
v0.3.4
v0.3.3
v0.3.2
v0.3.1
v0.3.0
v0.2.4
v0.2.3
v0.2.2
v0.2.1
v0.2.0
v0.1.0
GUIDES
Modules
API Reference
Modules
README
Sponsors
Installation
Documentation
Contributing
Licence
Tutorials
Getting started with Reactor
Transaction-like semantics with Sagas
Composing steps with the Reactor DSL
Building workflows programmatically
Mixing concurrent and synchronous workflow steps
Running your Reactor
Halting and resuming workflows
Dynamically adding steps at Reactor run time
DSLs
Reactor
reactor
Reactor
Sections
Usage
Summary
Types
async_option/0
concurrency_key_option/0
context/0
context_arg/0
halt_timeout_option/0
inputs/0
max_concurrency_option/0
max_iterations_option/0
options/0
state/0
t/0
timeout_option/0
Functions
is_reactor/1
run/4
run!/4
Dsl
Reactor.Dsl.Argument
Summary
Types
t/0
Functions
element/2
input/2
result/2
value/1
Reactor.Dsl.Around
Summary
Types
t/0
Reactor.Dsl.Build
Summary
Types
t/0
Functions
build/2
verify/2
Reactor.Dsl.Collect
Summary
Types
t/0
Reactor.Dsl.Compose
Summary
Types
t/0
Reactor.Dsl.Debug
Summary
Types
t/0
Reactor.Dsl.Flunk
Summary
Types
t/0
Reactor.Dsl.Group
Summary
Types
t/0
Reactor.Dsl.Guard
Summary
Types
t/0
Reactor.Dsl.Info
Summary
Functions
reactor/1
reactor_middlewares/1
reactor_options/1
reactor_return/1
reactor_return!/1
to_struct/1
to_struct!/1
Reactor.Dsl.Input
Summary
Types
t/0
Reactor.Dsl.Map
Summary
Types
t/0
Reactor.Dsl.Middleware
Summary
Types
t/0
Reactor.Dsl.Step
Summary
Types
t/0
Reactor.Dsl.Switch
Summary
Types
t/0
Reactor.Dsl.Switch.Default
Summary
Types
t/0
Reactor.Dsl.Switch.Match
Summary
Types
t/0
Reactor.Dsl.Template
Summary
Types
t/0
Reactor.Dsl.Verifier
Reactor.Dsl.WaitFor
Summary
Types
t/0
Reactor.Dsl.Where
Summary
Types
t/0
Steps
Reactor.Step
Summary
Types
arguments/0
capability/0
compensate_result/0
context/0
run_result/0
step/0
t/0
undo_result/0
Callbacks
async?/1
can?/2
compensate/4
run/3
undo/4
Functions
async?/1
can?/2
compensate/4
run/3
undo/4
Reactor.Step.AnonFn
Sections
Options
Reactor.Step.AnonFn.Mermaid
Reactor.Step.Around
Sections
Options
Wrapper function
Callback function
Example
Summary
Types
allow_async_option/0
around_fun/0
callback/0
function_option/0
options/0
steps_option/0
Reactor.Step.Around.Mermaid
Reactor.Step.Compose
Reactor.Step.Compose.Mermaid
Reactor.Step.Debug
Sections
Options
Summary
Types
level_option/0
options/0
Reactor.Step.Fail
Reactor.Step.Group
Sections
Options
Before function
After function
Summary
Types
after_fun/0
after_option/0
allow_async_option/0
before_fun/0
before_option/0
options/0
steps_option/0
Reactor.Step.Group.Mermaid
Reactor.Step.Map
Sections
Options
Reactor.Step.Map.Mermaid
Reactor.Step.ReturnAllArguments
Reactor.Step.ReturnArgument
Sections
Options.
Reactor.Step.Switch
Sections
Options
Branching behaviour
Returning
Summary
Types
allow_async_option/0
default_option/0
match_option/0
matches/0
on_option/0
options/0
predicate/0
Reactor.Step.Switch.Mermaid
Reactor.Step.Template
Sections
Options
Reactor.Step.Transform
Sections
Options
Reactor.Step.Transform.Mermaid
Reactor.Step.TransformAll
Middleware
Reactor.Middleware
Summary
Types
context/0
error_or_errors/0
result/0
step_event/0
t/0
Callbacks
complete/2
error/2
event/3
get_process_context/0
halt/1
init/1
set_process_context/1
Reactor.Middleware.Telemetry
Errors
Reactor.Error
Summary
Types
class/0
class_module/0
error_class/0
t/0
Functions
__using__/1
fetch_error/2
find_errors/2
splode_error?/2
unwrap!/2
Reactor.Error.Internal
Summary
Functions
exception/1
Reactor.Error.Internal.ComposeError
Summary
Functions
exception/1
Reactor.Error.Internal.MissingReturnResultError
Summary
Functions
exception/1
Reactor.Error.Internal.PlanError
Summary
Functions
exception/1
Reactor.Error.Internal.UnreachableError
Summary
Functions
exception/1
unreachable/1
unreachable!/1
Reactor.Error.Invalid
Summary
Functions
exception/1
Reactor.Error.Invalid.ArgumentSubpathError
Summary
Functions
exception/1
Reactor.Error.Invalid.CompensateStepError
Summary
Functions
exception/1
Reactor.Error.Invalid.ForcedFailureError
Summary
Types
t/0
Functions
exception/1
Reactor.Error.Invalid.InvalidResultError
Summary
Functions
exception/1
Reactor.Error.Invalid.MissingArgumentError
Summary
Functions
exception/1
Reactor.Error.Invalid.MissingInputError
Summary
Functions
exception/1
Reactor.Error.Invalid.MissingResultError
Summary
Functions
exception/1
Reactor.Error.Invalid.RetriesExceededError
Summary
Functions
exception/1
Reactor.Error.Invalid.RunStepError
Summary
Functions
exception/1
Reactor.Error.Invalid.TransformError
Summary
Functions
exception/1
Reactor.Error.Invalid.UndoRetriesExceededError
Summary
Functions
exception/1
Reactor.Error.Invalid.UndoStepError
Summary
Functions
exception/1
Reactor.Error.Unknown
Summary
Functions
exception/1
Reactor.Error.Unknown.UnknownError
Summary
Functions
exception/1
Reactor.Error.Validation
Summary
Functions
exception/1
Reactor.Error.Validation.MissingReturnError
Summary
Functions
exception/1
Reactor.Error.Validation.StateError
Summary
Functions
exception/1
Builder
Reactor.Builder
Sections
Example
Summary
Types
arguments_transform/0
async?/0
context/0
description/0
guards/0
impl/0
max_retries/0
ref/0
step_argument/0
step_options/0
Functions
add_input/3
add_input!/3
add_middleware/2
add_middleware!/2
add_step/5
add_step!/5
compose/5
compose!/5
ensure_middleware/2
ensure_middleware!/2
new/1
new_step/4
new_step!/4
return/2
return!/2
Reactor.Builder.Compose
Summary
Functions
compose/5
verify_arguments/2
Reactor.Builder.Input
Summary
Types
options/0
transform/0
Functions
add_input/3
Reactor.Builder.Step
Summary
Functions
add_step/5
new_step/4
Internals
Reactor.Argument
Summary
Types
options/0
t/0
transform/0
Functions
from_element/3
from_input/3
from_result/3
from_template/3
from_value/3
has_sub_path/1
has_transform/1
is_argument/1
is_from_element/1
is_from_input/1
is_from_result/1
is_from_value/1
sub_path/2
Reactor.Argument.Build
Summary
Types
t/0
Functions
build/1
Reactor.Executor
Summary
Functions
run/4
Reactor.Executor.Async
Summary
Functions
collect_remaining_tasks_for_shutdown/2
handle_completed_steps/2
start_steps/4
Reactor.Executor.ConcurrencyTracker
Summary
Types
pool_key/0
record/0
Functions
acquire/2
allocate_pool/1
child_spec/1
release/2
release_pool/1
status/1
Reactor.Executor.Hooks
Summary
Functions
complete/3
error/3
event/4
get_process_contexts/1
halt/2
init/2
set_process_contexts/1
Reactor.Executor.Init
Reactor.Executor.State
Summary
Types
t/0
Reactor.Executor.StepRunner
Summary
Functions
run/4
run_async/5
undo/5
Reactor.Executor.Sync
Summary
Functions
run/3
Reactor.Guard
Summary
Types
t/0
Reactor.Guard.Build
Summary
Types
t/0
Functions
build/1
Reactor.Info
Summary
Functions
reactor/1
reactor_middlewares/1
reactor_options/1
reactor_return/1
reactor_return!/1
to_struct/1
to_struct!/1
Reactor.Mermaid
Summary
Types
options/0
Callbacks
to_mermaid/2
Functions
to_mermaid/2
to_mermaid!/2
Reactor.Mermaid.Node
Summary
Types
node_data/0
node_list/0
t/0
Functions
render/2
Reactor.Mermaid.Utils
Summary
Functions
direction/1
md_escape/1
mermaid_id/2
name/1
Reactor.Planner
Summary
Functions
plan/1
plan!/1
Reactor.Template
Summary
Types
t/0
Functions
is_element_template/1
is_input_template/1
is_result_template/1
is_template/1
is_value_template/1
type/0
Reactor.Template.Element
Summary
Types
t/0
Reactor.Template.Input
Summary
Types
t/0
Reactor.Template.Result
Summary
Types
t/0
Reactor.Template.Value
Summary
Types
t/0
Search documentation of reactor
Settings
Reactor.Step.Fail
(reactor v0.15.2)
View Source
A very simple step which immediately returns an error.