Skip to content
API referenceDevelopmentEngine APIEngine ccf7d03f
Synced
  • Provides validated current-format serialization and atomic persistence for one settings document type.

API: engine
Inherits: object
Project: Inno.Core.Settings

public sealed class Inno.Core.Settings.SettingsDocumentStore<TDocument> where TDocument : class, Inno.Core.Serialization.ISerializable

Type parameter TDocument: The complete serializable document type.

Kind Element Description
Constructors SettingsDocumentStore<TDocument>.Constructor Creates a type-safe settings document store.
Methods SettingsDocumentStore<TDocument>.Capture Serializes a validated document without changing the file.
Methods SettingsDocumentStore<TDocument>.Deserialize Deserializes and validates a native payload without changing the file.
Methods SettingsDocumentStore<TDocument>.Load Loads the saved value, or creates a validated default when absent.
Methods SettingsDocumentStore<TDocument>.LoadRequired Loads a required saved value.
Methods SettingsDocumentStore<TDocument>.Restore Validates and atomically restores a native document payload.
Methods SettingsDocumentStore<TDocument>.Save Validates and atomically replaces the complete document.
Properties SettingsDocumentStore<TDocument>.documentName Gets the source’s logical diagnostic name without requiring a filesystem location.
Properties SettingsDocumentStore<TDocument>.exists Gets whether the document currently exists.