Class SettingsStore

The user's settings file and changes applied while running, as layers of the app's configuration.

Inheritance
object
SettingsStore
Implements
Inherited Members
Namespace: Uniform.Matrix.Hosting
Assembly: Uniform.Matrix.Hosting.dll
Syntax
public sealed class SettingsStore : ISettingsStore
Remarks

Layers from lowest: appsettings.json, the settings file, environment variables, the command line, then applied changes. Saving writes the settings file; applying sets the top layer until the next start. Both reload the configuration, so options read through IOptionsMonitor see the change.

Constructors

| Edit this page View Source

SettingsStore(IConfigurationRoot, AppliedConfigurationProvider, string)

Use configuration, which must contain applied and the settings file at path.

Declaration
public SettingsStore(IConfigurationRoot configuration, AppliedConfigurationProvider applied, string path)
Parameters
Type Name Description
IConfigurationRoot configuration
AppliedConfigurationProvider applied
string path

Properties

| Edit this page View Source

Path

The settings file.

Declaration
public string Path { get; }
Property Value
Type Description
string

Methods

| Edit this page View Source

AddLayers(IConfigurationBuilder, string)

Add the settings file and the applied layer to builder: the file right after the other JSON files, the applied layer on top.

Declaration
public static AppliedConfigurationProvider AddLayers(IConfigurationBuilder builder, string path)
Parameters
Type Name Description
IConfigurationBuilder builder
string path
Returns
Type Description
AppliedConfigurationProvider

The applied layer, for SettingsStore.
| Edit this page View Source

Apply(IReadOnlyDictionary<string, string?>)

Apply changes until the next start; a null value clears an applied change, so lower layers show again.

Declaration
public void Apply(IReadOnlyDictionary<string, string?> changes)
Parameters
Type Name Description
IReadOnlyDictionary<string, string> changes
| Edit this page View Source

DefaultPath(string)

Return the settings file of applicationName: settings.json in Config(string).

Declaration
public static string DefaultPath(string applicationName)
Parameters
Type Name Description
string applicationName
Returns
Type Description
string
| Edit this page View Source

GetSource(string)

Return which layer sets key: applied, command line, environment, a file name, or default.

Declaration
public string GetSource(string key)
Parameters
Type Name Description
string key
Returns
Type Description
string
| Edit this page View Source

GetValue(string)

Return the current value of key, e.g. Ui:InlineImages, or null when only the built-in default applies.

Declaration
public string? GetValue(string key)
Parameters
Type Name Description
string key
Returns
Type Description
string
| Edit this page View Source

Read(string)

Read a settings file as flat keys like Ui:InlineImages; empty when it does not exist.

Declaration
public static IReadOnlyDictionary<string, string?> Read(string path)
Parameters
Type Name Description
string path
Returns
Type Description
IReadOnlyDictionary<string, string>
| Edit this page View Source

Save(IReadOnlyDictionary<string, string?>)

Write changes into the settings file, keeping its other settings; a null value removes the setting. The changes are applied too.

Declaration
public void Save(IReadOnlyDictionary<string, string?> changes)
Parameters
Type Name Description
IReadOnlyDictionary<string, string> changes
| Edit this page View Source

Save(IReadOnlyDictionary<string, string?>, string)

Write changes into path, keeping its other settings; the changes are applied when it is the settings file.

Declaration
public void Save(IReadOnlyDictionary<string, string?> changes, string path)
Parameters
Type Name Description
IReadOnlyDictionary<string, string> changes
string path
| Edit this page View Source

Write(IReadOnlyDictionary<string, string?>, string)

Write changes into the settings file at path, keeping its other settings; a null value removes the setting. Nothing is applied, e.g. for an exported copy.

Declaration
public static void Write(IReadOnlyDictionary<string, string?> changes, string path)
Parameters
Type Name Description
IReadOnlyDictionary<string, string> changes
string path

Implements