ReadFiles Class

Summary

Reads the content of files from the file system into the content of new documents.
Assembly
Wyam.Core.dll
Namespace
Wyam.Core.Modules.IO
Interfaces
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type-.->Interface1["IAsNewDocuments"] click Interface1 "/api/Wyam.Common.Modules/IAsNewDocuments" Type["ReadFiles"] class Type type-node

Syntax

public class ReadFiles : IModule, IAsNewDocuments

Remarks

For each output document, several metadata values are set with information about the file. This module will be executed once and input documents will be ignored if search patterns are specified. Otherwise, if a delegate is specified, the module will be executed once per input document and the resulting output documents will be aggregated. In either case, the input documents will not be returned as output of this module. If you want to add additional files to a current pipeline, you should enclose your ReadFiles modules with Wyam.Core.Modules.Control.Concat.

Constructors

Name Summary
ReadFiles(ContextConfig) Reads all files that match the specified globbing patterns and/or absolute paths. This allows you to specify different patterns and/or paths depending on the context.
ReadFiles(DocumentConfig) Reads all files that match the specified globbing patterns and/or absolute paths. This allows you to specify different patterns and/or paths depending on the input.
ReadFiles(string[]) Reads all files that match the specified globbing patterns and/or absolute paths.

Methods

Name Value Summary
Execute(IReadOnlyList<IDocument>, IExecutionContext) IEnumerable<IDocument>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
Where(Func<IFile, bool>) ReadFiles
Specifies a predicate that must be satisfied for the file to be read.
GitHub