Table of Contents

Namespace Nucs.JsonSettings.Modulation

Classes

Base64Module

Will convert text to base64, not pure json.

EncryptionModule

Encrypts the serialized configuration with a symmetric algorithm from the .NET base class library (System.Security.Cryptography). The algorithm is selected with Algorithm; the default, AesCbc, is byte-for-byte compatible with every file this library has ever written.

EnforcedVersionAttribute

This attribute used to specify the default version that the loaded config must be when using VersioningModule

InvalidVersionException
ModularityException
Module

A module that can be attached to a ISocket

ModuleSocket

A subclass to manage modulation of a JsonSettings

RijndaelModule

Obsolete alias for EncryptionModule. Retained only so existing new RijndaelModule(...) and RijndaelModule.FromRawKey(...) call sites keep compiling; every member forwards to EncryptionModule, which now runs on System.Security.Cryptography directly. The default algorithm and the on-disk format are unchanged, so a module built through this shim reads and writes exactly what it did before.

SuspensionModule

The neutral save-suspension state a settings instance carries while some flavour of autosave is enabled: the re-entrancy and loading gates, and the reference-counted suspension machine.

VersioningModule
VersioningModule<T>

VersioningModule used to enforce a policy and take VersioningResultAction when the policy detects an invalid version. A policy is a comparer between two Version.

Interfaces

ISocket

A class that can be attached to and deattached from with Modules.

IVersionable

Enums

VersioningResultAction

In a case of an invalid action, what should be the course.

Delegates

VersioningPolicyHandler

Returns true when version is matching. False if invalid.