A read-only interface to the
IEngine used during an execution.
- Namespace
- Statiq
.Common - Interfaces
- Implementing Types
graph BT
Type-.->Interface0["IDocumentFactory"]
click Interface0 "/api/Statiq.Common/IDocumentFactory"
Type["IExecutionState"]
class Type type-node
Implementing0["TestExecutionContext"]-.->Type
click Implementing0 "/api/Statiq.Testing/TestExecutionContext"
Implementing1["TestAnalyzerContext"]-.->Type
click Implementing1 "/api/Statiq.Testing/TestAnalyzerContext"
Implementing2["TestEngine"]-.->Type
click Implementing2 "/api/Statiq.Testing/TestEngine"
Implementing3["Engine"]-.->Type
click Implementing3 "/api/Statiq.Core/Engine"
Implementing4["IEngine"]-.->Type
click Implementing4 "/api/Statiq.Common/IEngine"
Implementing5["IAnalyzerContext"]-.->Type
click Implementing5 "/api/Statiq.Common/IAnalyzerContext"
Implementing6["IExecutionContext"]-.->Type
click Implementing6 "/api/Statiq.Common/IExecutionContext"
Syntax
public interface IExecutionState : IDocumentFactoryProperties
| Name | Property Type | Summary |
|---|---|---|
| ApplicationState | IApplicationState |
Gets the state of the application when it was run.
|
| CancellationToken | CancellationToken |
Gets a cancellation token that will be canceled when processing should stop.
|
| ClassCatalog | ClassCatalog |
A catalog of all classes in all assemblies loaded by the current application context.
|
| Current | IExecutionState |
The current execution state (which is the
IExecutionContext if there is one, and usually the IEngine if not).
static
|
| Events | I |
Gets global events and event handlers.
|
| ExecutingPipelines | I |
The pipelines currently being executed.
|
| ExecutionDateTime | DateTime |
The date/time that the current execution started.
|
| ExecutionId | Guid |
Uniquely identifies the current execution cycle. This can be used to initialize and/or
reset static data for a module on new generations (I.e., due to watching).
For example, cache data could be cleared when this changes between runs.
|
| FileSystem | IReadOnlyFileSystem |
Gets the current file system.
|
| LinkGenerator | ILinkGenerator |
Helps generate normalized links.
|
| Logger | ILogger | |
| MemoryStreamFactory | IMemoryStreamFactory |
Provides pooled memory streams (via the RecyclableMemoryStream library).
|
| Namespaces | I |
Gets a set of namespaces that should be brought into scope for modules that perform dynamic compilation.
|
| OutputPages | FilteredDocumentList |
Gets the collection of output documents from all previously processed pipelines,
filtered to destination paths with a
PageFileExtensions
extension (which defaults to ".htm" and ".html").
|
| Outputs | IPipelineOutputs |
Gets the collection of output documents from all previously processed pipelines.
|
| Pipelines | I |
Gets the pipelines.
|
| ScriptHelper | IScriptHelper |
Gets a helper that can compile and evaluate C# scripts.
|
| SerialExecution | bool |
Indicates that the engine is executing pipeline phases and modules in serial.
|
| Services | IServiceProvider |
Gets the dependency injection service provider.
|
| Settings | IReadOnlySettings |
The application configuration as metadata.
|
| Shortcodes | I |
Gets the available shortcodes.
|
Methods
| Name | Return Value | Summary |
|---|---|---|
| CreateHttpClient |
HttpClient |
Creates a
HttpClient instance that should be used for all HTTP communication.
|
| CreateHttpClient |
HttpClient |
Creates a new
HttpClient instance that uses a custom message handler.
|
| GetContentStream |
Stream |
Gets a
Stream that can be used for document content. If content
is not null, the stream is initialized with the specified content. It is preferred to use
this method to obtain a stream over creating your own if the source of the content does
not already provide one. The returned streams are optimized for memory usage and performance.
Instances of the returned stream should be disposed when writing is complete.
|
| Get |
I |
Gets a new
IJavaScriptEnginePool. The returned engine pool should be disposed
when no longer needed.
|
| Send |
Task |
Sends an
HttpRequestMessage with exponential back-off.
|
| Send |
Task |
Sends an
HttpRequestMessage with exponential back-off.
|
Extension Methods
| Name | Value | Summary |
|---|---|---|
| Clone |
IDocument | |
| Clone |
IDocument | |
| Clone |
IDocument | |
| Clone |
IDocument | |
| Clone |
IDocument | |
| Clone |
IDocument | |
| Clone |
TDocument | |
| Clone |
TDocument | |
| Clone |
TDocument | |
| Clone |
TDocument | |
| Clone |
TDocument | |
| Clone |
TDocument | |
| CreateDocument |
IDocument | |
| CreateDocument |
IDocument | |
| CreateDocument |
IDocument | |
| CreateDocument |
IDocument | |
| CreateDocument |
IDocument | |
| CreateDocument |
TDocument | |
| CreateDocument |
TDocument | |
| CreateDocument |
TDocument | |
| CreateDocument |
TDocument | |
| CreateDocument |
TDocument | |
| GetCurrentDateTime |
DateTime |
Gets the current date/time using the
CurrentDateTime metadata setting if it's set,
otherwise using the value of ExecutionDateTime (which is
System.DateTime.Now at the time execution started).
|
| GetLink |
string |
Gets a link for the specified document using the document destination.
This version should be used inside modules to ensure
consistent link generation. Note that you can optionally include the host or not depending
on if you want to generate host-specific links. By default, the host is not included so that
sites work the same on any server including the preview server.
|
| GetLink |
string |
Gets a link for the specified metadata using the specified metadata value and the default settings from the
configuration. This version should be used inside modules to ensure
consistent link generation. Note that you can optionally include the host or not depending
on if you want to generate host-specific links. By default, the host is not included so that
sites work the same on any server including the preview server.
|
| GetLink |
string |
Gets a link for the specified metadata using the specified metadata value and the default settings from the
configuration. This version should be used inside modules to ensure
consistent link generation. Note that you can optionally include the host or not depending
on if you want to generate host-specific links. By default, the host is not included so that
sites work the same on any server including the preview server.
|
| GetLink |
string |
Converts the specified path into a string appropriate for use as a link using default settings from the
configuration. This version should be used inside modules to ensure
consistent link generation. Note that you can optionally include the host or not depending
on if you want to generate host-specific links. By default, the host is not included so that
sites work the same on any server including the preview server.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the specified path into a string appropriate for use as a link using default settings from the
configuration. This version should be used inside modules to ensure
consistent link generation. Note that you can optionally include the host or not depending
on if you want to generate host-specific links. By default, the host is not included so that
sites work the same on any server including the preview server.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Converts the path into a string appropriate for use as a link, overriding one or more
settings from the configuration.
|
| GetLink |
string |
Gets a link for the root of the site using the host and root path specified in the settings.
|
| Send |
Task |
Sends a GET request with exponential back-off.
|
| Send |
Task |
Sends a GET request with exponential back-off.
|
| ThrowIfNull |
T |
From GuardExtensions
|
| ToDocument |
IDocument | |
| ToDocument |
IDocument | |
| ToDocument |
IDocument | |
| ToDocument |
IDocument | |
| ToDocument |
IDocument | |
| ToDocument |
IDocument |