Step error {http://pipx.org/ns/pipx}

Throws an error, with a proper title, message, and other infos.

This is the central piece in the error handling machanism, still to define precisely.

TODO: Error handling machanism, still to define precisely!

TODO: Enable the ability to give an input to p:error, through an input to this step. Maybe we should have either the option message or the port message (a template in both cases).

Defined in: src/pipx.xpl

Input Ports

PortDescription
source primary sequence

Additional input to add in the error document.

parameters primary parameter

The parameters used in '{...}' replacements in $title and $message.

Output Ports

PortDescription
result primary

The output of the resulting p:error.

Options

Local NameNamespace URIDefaultDescription
code required

The error code, following the same requirements as the option code of p:error.

code-prefix

The error code prefix, following the same requirements as the option code-prefix of p:error.

code-namespace

The error code namespace, following the same requirements as the option code-namespace of p:error.

title required

The error title, can contain '{' and '}' as in p:template.

message required

The error message, can contain '{' and '}' as in p:template.