Pipeline<TContext, TBaseNode>.Run Method
Overloads
| Name | Description |
|---|---|
Run(TContext, TBaseNode, TBaseNode) |
Runs the pipeline on the specified root node, returning the potentially new root via an out parameter. |
Run(TContext, TBaseNode, TBaseNode, String) |
Runs the pipeline on the specified root node, returning the potentially new root and last stage run via out parameters. |
Run(TContext, TBaseNode) |
Runs the pipeline on the specified root node, returning a tuple with the result, the potentially replaced root node and the last stage run. |
Run(TContext, TBaseNode, TBaseNode)
Runs the pipeline on the specified root node, returning the potentially new root via an out parameter.
public bool Run(TContext? context, TBaseNode root, out TBaseNode newRoot);
Parameters
| Name | Type | Description |
|---|---|---|
context |
TContext |
The processing context. |
root |
TBaseNode |
The root node to run the pipeline on. |
newRoot |
TBaseNode |
The root node after processing, which may have been replaced by a Replacer<TContext, TBaseNode>. |
Returns
true if all stages ran successfully, false otherwise.
Run(TContext, TBaseNode, TBaseNode, String)
Runs the pipeline on the specified root node, returning the potentially new root and last stage run via out parameters.
public bool Run(TContext? context, TBaseNode root, out TBaseNode newRoot, out string lastStageRun);
Parameters
| Name | Type | Description |
|---|---|---|
context |
TContext |
The processing context. |
root |
TBaseNode |
The root node to run the pipeline on. |
newRoot |
TBaseNode |
The root node after processing, which may have been replaced by a Replacer<TContext, TBaseNode>. |
lastStageRun |
String |
The name of the last stage that was run. If false is returned then this will be the name of the stage that stopped further stages from continuing. |
Returns
true if all stages ran successfully, false otherwise.
Run(TContext, TBaseNode)
Runs the pipeline on the specified root node, returning a tuple with the result, the potentially replaced root node and the last stage run.
public ValueTuple<bool, TBaseNode, string> Run(TContext? context, TBaseNode root);
Parameters
| Name | Type | Description |
|---|---|---|
context |
TContext |
The processing context. |
root |
TBaseNode |
The root node to run the pipeline on. |
Returns
ValueTuple<Boolean, TBaseNode, String>
A tuple of whether all stages ran successfully, the root node which may have been replaced, and the name of the last stage that was run.