Pipeline<TBaseNode>.Run Method

Overloads

Name	Description
Run(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(TBaseNode, out TBaseNode)	Runs the pipeline on the specified root node, returning the potentially new root via an out parameter.
Run(TBaseNode, out TBaseNode, out String)	Runs the pipeline on the specified root node, returning the potentially new root and last stage run via out parameters.

Run(TBaseNode)

Definition

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 (bool Success, TBaseNode Root, string LastStageRun) Run(TBaseNode root);

Parameters

Name	Type	Description
root	TBaseNode	The root node to run the pipeline on.

Returns

(bool Success, TBaseNode Root, String LastStageRun) 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.

Run(TBaseNode, out TBaseNode)

Definition

Runs the pipeline on the specified root node, returning the potentially new root via an out parameter.

public bool Run(TBaseNode root, out TBaseNode newRoot);

Parameters

Name	Type	Description
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<TBaseNode>.

Returns

Boolean true if all stages ran successfully, false otherwise.

Run(TBaseNode, out TBaseNode, out String)

Definition

Runs the pipeline on the specified root node, returning the potentially new root and last stage run via out parameters.

public bool Run(TBaseNode root, out TBaseNode newRoot, out string lastStageRun);

Parameters

Name	Type	Description
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<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

Boolean true if all stages ran successfully, false otherwise.

Last modified: 10 March 2026