IExecutionCache Interface

Summary

Provides a cache that can be used by modules during execution to persist data between engine executions. Cached data is keyed by both a document and an optional key string.
Assembly
Wyam.Common.dll
Namespace
Wyam.Common.Caching
Implementing Types
graph BT Type["IExecutionCache"] class Type type-node Implementing0["TestExecutionCache"]-.->Type click Implementing0 "/api/Wyam.Testing.Caching/TestExecutionCache"

Syntax

public interface IExecutionCache

Methods

Name Value Summary
ContainsKey(IDocument) bool
Checks if the document key is in the cache.
ContainsKey(IDocument, string) bool
Checks if the document and string key is in the cache.
ContainsKey(string) bool
Checks if the string key is in the cache.
Set(IDocument, Object) void
Sets a cached value from a document key.
Set(IDocument, string, Object) void
Sets a cached value from a document and string key.
Set(string, Object) void
Sets a cached value from a document key.
TryGetValue(IDocument, Object) bool
Attempts to get a cached value from a document key.
TryGetValue(IDocument, string, Object) bool
Attempts to get a cached value from a document and string key.
TryGetValue(string, Object) bool
Attempts to get a cached value from a string key.
TryGetValue<TValue>(IDocument, string, TValue) bool
Attempts to get a typed cached value from a document and string key.
TryGetValue<TValue>(IDocument, TValue) bool
Attempts to get a typed cached value from a document key.
TryGetValue<TValue>(string, TValue) bool
Attempts to get a typed cached value from a string key.
GitHub