IPipeline Interface
Represents a named collection of modules that should be executed by the engine.
graph BT Type-.->Interface0["IReadOnlyPipeline"] click Interface0 "/api/Statiq.Common/IReadOnlyPipeline" Type["IPipeline"] class Type type-node Implementing0["Content"]-.->Type click Implementing0 "/api/Statiq.Web.Pipelines/Content" Implementing1["DirectoryMetadata"]-.->Type click Implementing1 "/api/Statiq.Web.Pipelines/DirectoryMetadata" Implementing2["INamedPipeline"]-.->Type click Implementing2 "/api/Statiq.Common/INamedPipeline" Implementing3["Sitemap"]-.->Type click Implementing3 "/api/Statiq.Web.Pipelines/Sitemap" Implementing4["Assets"]-.->Type click Implementing4 "/api/Statiq.Web.Pipelines/Assets" Implementing5["AnalyzeContent"]-.->Type click Implementing5 "/api/Statiq.Web.Pipelines/AnalyzeContent" Implementing6["Inputs"]-.->Type click Implementing6 "/api/Statiq.Web.Pipelines/Inputs" Implementing7["Code"]-.->Type click Implementing7 "/api/Statiq.Docs.Pipelines/Code" Implementing8["NamedPipelineWrapper"]-.->Type click Implementing8 "/api/Statiq.Common/NamedPipelineWrapper" Implementing9["Deployment"]-.->Type click Implementing9 "/api/Statiq.Web.Pipelines/Deployment" Implementing10["Api"]-.->Type click Implementing10 "/api/Statiq.Docs.Pipelines/Api" Implementing11["SearchIndex"]-.->Type click Implementing11 "/api/Statiq.Web.Pipelines/SearchIndex" Implementing12["Pipeline"]-.->Type click Implementing12 "/api/Statiq.Core/Pipeline" Implementing13["Data"]-.->Type click Implementing13 "/api/Statiq.Web.Pipelines/Data" Implementing14["INamedPipelineWrapper"]-.->Type click Implementing14 "/api/Statiq.Common/INamedPipelineWrapper" Implementing15["TestPipeline"]-.->Type click Implementing15 "/api/Statiq.Testing/TestPipeline" Implementing16["Redirects"]-.->Type click Implementing16 "/api/Statiq.Web.Pipelines/Redirects" Implementing17["Archives"]-.->Type click Implementing17 "/api/Statiq.Web.Pipelines/Archives" Implementing18["Feeds"]-.->Type click Implementing18 "/api/Statiq.Web.Pipelines/Feeds" Implementing19["ExecutionPipeline"]-.->Type click Implementing19 "/api/Statiq.Core/ExecutionPipeline"

Syntax

public interface IPipeline : IReadOnlyPipeline

Remarks

If the pipeline implements IDisposable, System.IDisposable.Dispose will be called when the engine is disposed (I.e., on application exit).

Properties

Name Property Type Summary
Dependencies HashSet<string>
DependencyOf HashSet<string>
Deployment bool
ExecutionPolicy ExecutionPolicy
InputModules ModuleList
Modules that will execute during the input phase.
Isolated bool
OutputModules ModuleList
Modules that will execute during the output phase.
PostProcessModules ModuleList
Modules that will execute during the post-process phase.
ProcessModules ModuleList
Modules that will execute during the process phase.

Extension Methods

Name Value Summary
AlwaysExecute<IPipeline>() TPipeline
AsDependencyOf<IPipeline>(IEnumerable<string>) TPipeline
AsDependencyOf<IPipeline>(string[]) TPipeline
AsDeployment<IPipeline>(bool) TPipeline
AsIsolated<IPipeline>(bool) TPipeline
GetAllDependencies(IExecutionState) IEnumerable<string>
Gets all dependencies of this pipeline including DependencyOf declarations.
GetAllDependencies(IReadOnlyPipelineCollection) IEnumerable<string>
Gets all dependencies of this pipeline including DependencyOf declarations.
ManuallyExecute<IPipeline>() TPipeline
NormallyExecute<IPipeline>() TPipeline
ThrowIfNull<IPipeline>(string) T
ToDocument<IPipeline>(IContentProvider) IDocument
ToDocument<IPipeline>(IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<IPipeline>(NormalizedPath, IContentProvider) IDocument
ToDocument<IPipeline>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
ToDocument<IPipeline>(NormalizedPath, NormalizedPath, IContentProvider) IDocument
ToDocument<IPipeline>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider) IDocument
WithDependencies<IPipeline>(IEnumerable<string>) TPipeline
WithDependencies<IPipeline>(string[]) TPipeline
WithExecutionPolicy<IPipeline>(ExecutionPolicy) TPipeline
WithInputConfig<IPipeline>(Config<object>) TPipeline
WithInputModules<IPipeline>(IEnumerable<IModule>) TPipeline
WithInputModules<IPipeline>(IModule[]) TPipeline
WithOutputConfig<IPipeline>(Config<object>) TPipeline
WithOutputModules<IPipeline>(IEnumerable<IModule>) TPipeline
WithOutputModules<IPipeline>(IModule[]) TPipeline
WithPostProcessConfig<IPipeline>(Config<object>) TPipeline
WithPostProcessModules<IPipeline>(IEnumerable<IModule>) TPipeline
WithPostProcessModules<IPipeline>(IModule[]) TPipeline
WithProcessConfig<IPipeline>(Config<object>) TPipeline
WithProcessModules<IPipeline>(IEnumerable<IModule>) TPipeline
WithProcessModules<IPipeline>(IModule[]) TPipeline