| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .. | ||
| Contracts | ||
| CultCache.cs | ||
| CultDocumentContracts.cs | ||
| CultGeneratedDocumentMetadata.cs | ||
| GameCult.Caching.csproj | ||
| GameCult.Caching.txt | ||
| README.md | ||
| ReflectionExtensions.cs | ||
GameCult.Caching
GameCult.Caching is an attribute-driven typed cache with a canonical
single-file MessagePack store. Domain models stay clean. The cache owns record
keys, schema ids, timestamps, and persistence metadata instead of smearing
that sludge across every class.
Authoring Model
Cacheable models are plain classes annotated with cache intent.
using GameCult.Caching;
using MessagePack;
[CultDocument("gamecult.item_data", "gamecult.item_data.v1")]
public sealed class ItemData
{
[Key(0)]
[CultName]
public string Name = string.Empty;
[Key(1)]
[CultIndex]
public string Category = string.Empty;
[Key(2)]
public int Value;
}
Available cache attributes:
CultDocument(schemaName, schemaVersion)CultNameCultIndex(alias?)CultGlobalCultReference(targetType?, many: false)
If you want compile-time document metadata instead of runtime assembly
spelunking, add the GameCult.Caching.MessagePack.Generator analyzer to the
project that declares your [CultDocument] types. It emits a metadata provider
the cache registry can load directly, while reflection stays behind as fallback
for projects that have not taken the hint yet.
Main Concepts
Record keys and handles
CultCache gives each stored document a cache-owned CultRecordKey. You work
with typed handles instead of forcing storage identity into the domain object.
var cache = new CultCache();
var handle = await cache.AddAsync(new ItemData
{
Name = "Potion",
Category = "Consumable",
Value = 50
});
var potion = cache.Get<ItemData>(handle.Key);
Name and index lookups
Name and index lookups are driven from attributes, not manual registration.
var byName = cache.GetByName<ItemData>("Potion");
var byIndex = cache.GetByIndex<ItemData>("Category", "Consumable");
Explicit references
References stay explicit in the domain. The cache will resolve them on demand, but it will not quietly build an entire haunted object graph behind your back.
[CultDocument("gamecult.quest_data", "gamecult.quest_data.v1")]
public sealed class QuestData
{
[Key(0)] public string Title = string.Empty;
[Key(1)] [CultReference] public CultRecordRef<ItemData> Reward;
}
Persistence Shape
CultCache persistence is store-shaped, not entry-shaped:
- store header
- embedded schema catalog
- records
Each persisted record carries:
keyschemaIdstoredAtpayload
The domain payload stays free of storage metadata.
Backing Store
CultCache now has one sanctioned persistence format:
SingleFileMessagePackBackingStore
It persists the whole store as:
- store format version
- embedded schema catalog
- persisted records
Each persisted record carries:
keyschemaIdstoredAtpayload
Typical Startup
using GameCult.Caching;
using GameCult.Caching.MessagePack;
var cache = new CultCache();
var store = new SingleFileMessagePackBackingStore("Data.msgpack");
cache.AddBackingStore(store);
await cache.PullAllBackingStoresAsync();