plumbery
Nested DSLs
plumbery.pipeline
pipeline name
Nested DSLs
Arguments
Name | Type | Default | Docs |
---|
name | atom | | The name of the pipeline. This becomes the name of the generated function |
Options
Name | Type | Default | Docs |
---|
doc | String.t | | Documentation for generated function |
unwrap | boolean | false | When true, the pipeline will unwrap the result before returning. Makes sense only for pipelines that are not meant to be used in other pipelines |
private | boolean | false | When true, the generated pipeline function is private |
plumbery.pipeline.pipe
pipe function
Adds a pipe to pipeline.
Arguments
Name | Type | Default | Docs |
---|
function | atom | {module, atom} | | Function to call. Can be either local function name specified as atom, or remote function specified as {Module, :function} tuple. Local functions can be private |
Introspection
Target: Plumbery.Pipe
plumbery.pipeline.escape_on_error
escape_on_error escape
Arguments
Name | Type | Default | Docs |
---|
escape | boolean | true | When true, the pipeline will not call any more pipes as soon as one of the pipes returns an error |
Introspection
Target: Plumbery.EscapeOnError
plumbery.pipeline.inlet
inlet signature
Arguments
Name | Type | Default | Docs |
---|
signature | any | | Signature of generated function. Named arguments will be copied to request's command |
Options
Name | Type | Default | Docs |
---|
request | module | Plumbery.Request | Module that provides the struct to be used as request |
command | module | | Module that provides the struct to be used as command. If not specified, a map will be used |
use_context | boolean | | When true, an aditional argument will be added to the function, and its value will be copied to request's context field |
Introspection
Target: Plumbery.Inlet
Introspection
Target: Plumbery.Pipeline
plumbery.inlet
inlet signature
Arguments
Name | Type | Default | Docs |
---|
signature | any | | Signature of generated function. Named arguments will be copied to request's command |
Options
Name | Type | Default | Docs |
---|
pipeline | module | {module, atom} | | Pipeline to call |
request | module | Plumbery.Request | Module that provides the struct to be used as request |
command | module | | Module that provides the struct to be used as command. If not specified, a map will be used |
use_context | boolean | | When true, an aditional argument will be added to the function, and its value will be copied to request's context field |
Introspection
Target: Plumbery.Inlet