View Source DSL: Plumbery.Dsl

plumbery

Nested DSLs

plumbery.pipeline

pipeline name

Nested DSLs

Arguments

NameTypeDefaultDocs
nameatomThe name of the pipeline. This becomes the name of the generated function

Options

NameTypeDefaultDocs
docString.tDocumentation for generated function
unwrapbooleanfalseWhen true, the pipeline will unwrap the result before returning. Makes sense only for pipelines that are not meant to be used in other pipelines
privatebooleanfalseWhen true, the generated pipeline function is private

plumbery.pipeline.pipe

pipe function

Adds a pipe to pipeline.

Arguments

NameTypeDefaultDocs
functionatom | {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

NameTypeDefaultDocs
escapebooleantrueWhen 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

NameTypeDefaultDocs
signatureanySignature of generated function. Named arguments will be copied to request's command

Options

NameTypeDefaultDocs
requestmodulePlumbery.RequestModule that provides the struct to be used as request
commandmoduleModule that provides the struct to be used as command. If not specified, a map will be used
use_contextbooleanWhen 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

NameTypeDefaultDocs
signatureanySignature of generated function. Named arguments will be copied to request's command

Options

NameTypeDefaultDocs
pipelinemodule | {module, atom}Pipeline to call
requestmodulePlumbery.RequestModule that provides the struct to be used as request
commandmoduleModule that provides the struct to be used as command. If not specified, a map will be used
use_contextbooleanWhen 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