Class FileProcessingPipeline
Represents a pipeline for processing files using a series of FileProcessor instances.
Namespace: FulcrumFS
Assembly: FulcrumFS.dll
Syntax
public class FileProcessingPipeline : IFileProcessingPipelineProvider, IFileProcessingPipelineSelectorConstructors
| Name | Description |
|---|---|
| FileProcessingPipeline(params IEnumerable<FileProcessor>) | Initializes a new instance of the FileProcessingPipeline class with the specified file processors. |
Properties
| Name | Description |
|---|---|
| AliasWhenVariantSourceUnchanged | Gets or initializes a value indicating whether a variant pipeline should produce an alias to its source variant when running the pipeline results in no changes to the source file. Default value is false. |
| Empty | Gets an empty file process pipeline that does not perform any processing on files. |
| Processors | Gets the collection of file processors that will be used in this pipeline to process files. |
| SourceBufferingMode | Gets or initializes the mode for buffering source streams to temporary repository work files. Default value is Auto. |
| ThrowWhenMainSourceUnchanged | Gets or initializes a value indicating whether the main pipeline of a FileRepoTransaction add call should throw a FileSourceUnchangedException when running the pipeline results in no changes to the source file. Default value is false. |
| Variants | Gets or initializes the collection of auto-variants produced after the main pipeline completes. Each variant pipeline receives the output of this pipeline as its source. Variants are IFileProcessingPipelineProviders so their nested variant trees can be enumerated ahead of execution. |
Methods
| Name | Description |
|---|---|
| WithVariant(string, IFileProcessingPipelineProvider) | Returns a new FileProcessingPipeline with the specified variant appended to Variants. |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IFileProcessingPipelineProvider.GetPipeline() | Gets the pipeline produced by this provider. |
| IFileProcessingPipelineSelector.GetPipeline(string) | Gets the pipeline to use for processing a file with the specified source extension. |