A module that processes documents in parallel (with the option to process sequentially).
- Namespace
- Statiq
.Common - Interfaces
- Base Types
-
- object
- Module
- Derived Types
graph BT
Type-->Base0["Module"]
click Base0 "/api/Statiq.Common/Module"
Base0-->Base1["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type-.->Interface1["IParallelModule"]
click Interface1 "/api/Statiq.Common/IParallelModule"
Type["ParallelModule"]
class Type type-node
Derived0["RenderScriban"]-->Type
click Derived0 "/api/Statiq.Scriban/RenderScriban"
Derived1["CopyMetadata"]-->Type
click Derived1 "/api/Statiq.Core/CopyMetadata"
Derived2["InsertLinks"]-->Type
click Derived2 "/api/Statiq.Core/InsertLinks"
Derived3["EvaluateScript"]-->Type
click Derived3 "/api/Statiq.Core/EvaluateScript"
Derived4["ProcessHtml"]-->Type
click Derived4 "/api/Statiq.Core/ProcessHtml"
Derived5["GenerateExcerpt"]-->Type
click Derived5 "/api/Statiq.Core/GenerateExcerpt"
Derived6["RenderMarkdown"]-->Type
click Derived6 "/api/Statiq.Markdown/RenderMarkdown"
Derived7["CompileSass"]-->Type
click Derived7 "/api/Statiq.Sass/CompileSass"
Derived8["ParseJson"]-->Type
click Derived8 "/api/Statiq.Core/ParseJson"
Derived9["AddRtlSupport"]-->Type
click Derived9 "/api/Statiq.Core/AddRtlSupport"
Derived10["MakeLinksRootRelative"]-->Type
click Derived10 "/api/Statiq.Core/MakeLinksRootRelative"
Derived11["ReadApi<TClient>"]-->Type
click Derived11 "/api/Statiq.Core/ReadApi_1"
Derived12["AddTitle"]-->Type
click Derived12 "/api/Statiq.Core/AddTitle"
Derived13["EscapeHtml"]-->Type
click Derived13 "/api/Statiq.Core/EscapeHtml"
Derived14["InsertHtml"]-->Type
click Derived14 "/api/Statiq.Core/InsertHtml"
Derived15["TransformXslt"]-->Type
click Derived15 "/api/Statiq.Core/TransformXslt"
Derived16["ProcessShortcodes"]-->Type
click Derived16 "/api/Statiq.Core/ProcessShortcodes"
Derived17["QueryHtml"]-->Type
click Derived17 "/api/Statiq.Core/QueryHtml"
Derived18["MakeLinksAbsolute"]-->Type
click Derived18 "/api/Statiq.Core/MakeLinksAbsolute"
Derived19["RenderHandlebars"]-->Type
click Derived19 "/api/Statiq.Handlebars/RenderHandlebars"
Syntax
public abstract class ParallelModule : Module, IModule, IParallelModuleProperties
| Name | Property Type | Summary |
|---|---|---|
| Parallel | bool |
Indicates whether documents will be
processed by this module in parallel.
|
Methods
| Name | Return Value | Summary |
|---|---|---|
| AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
| AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
| BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
|
| ExecuteInputAsync |
Task |
Executes the module.
Inherited from Module
|
| Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|