Class PersistentSettings

Namespace

CarinaStudio.Configuration

Assembly

CarinaStudio.AppBase.Configuration.dll

Base implementation of ISettings which can be loaded/saved from/to file. This is thread-safe class.

public abstract class PersistentSettings : ISettings

Inheritance

object

PersistentSettings

Implements

ISettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

SettingsExtensions.GetValueOrDefault(ISettings?, SettingKey)

SettingsExtensions.GetValueOrDefault<T>(ISettings?, SettingKey<T>)

SettingsExtensions.IsFalse(ISettings, SettingKey<bool>)

SettingsExtensions.IsTrue(ISettings, SettingKey<bool>)

SettingsExtensions.ResetValues(ISettings)

SettingsExtensions.ResetValues(ISettings, IEnumerable<SettingKey>)

SettingsExtensions.SetValue<T>(ISettings, SettingKey<T>, T)

SettingsExtensions.ToggleValue(ISettings, SettingKey<bool>)

SettingsExtensions.ValuesEqual(ISettings, ISettings)

SettingsExtensions.VerifyValue(ISettings, SettingKey)

ObjectExtensions.AddWeakEventHandler<TObject>(TObject, string, Action)

ObjectExtensions.AddWeakEventHandler<TObject>(TObject, string, EventHandler)

ObjectExtensions.AddWeakEventHandler<TObject, TArg>(TObject, string, Action<TArg>)

ObjectExtensions.AddWeakEventHandler<TObject, TArgs>(TObject, string, EventHandler<TArgs>)

ObjectExtensions.AddWeakEventHandler<TObject, TArg1, TArg2>(TObject, string, Action<TArg1, TArg2>)

ObjectExtensions.AddWeakEventHandler<TObject, TArg1, TArg2, TArg3>(TObject, string, Action<TArg1, TArg2, TArg3>)

ObjectExtensions.AlsoAsync<T>(T, Func<T, Task>)

ObjectExtensions.Also<T>(T, Action<T>)

ObjectExtensions.AsNonNull<T>(T?)

ObjectExtensions.LetAsync<T>(T, Func<T, Task>)

ObjectExtensions.LetAsync<T, R>(T, Func<T, Task<R>>)

ObjectExtensions.Let<T>(T, Action<T>)

ObjectExtensions.Let<T, R>(T, RefOutFunc<T, R>)

ObjectExtensions.Let<T, R>(T, Func<T, R>)

ObjectExtensions.LockAsync<T>(T, Func<T, Task>)

ObjectExtensions.LockAsync<T>(T, Func<Task>)

ObjectExtensions.LockAsync<T, R>(T, Func<T, Task<R>>)

ObjectExtensions.LockAsync<T, R>(T, Func<Task<R>>)

ObjectExtensions.Lock<T>(T, Action)

ObjectExtensions.Lock<T>(T, Action<T>)

ObjectExtensions.Lock<T, R>(T, RefOutFunc<T, R>)

ObjectExtensions.Lock<T, R>(T, RefOutFunc<R>)

ObjectExtensions.Lock<T, R>(T, Func<T, R>)

ObjectExtensions.Lock<T, R>(T, Func<R>)

ObjectExtensions.TryCastAndRunAsync<T>(object?, Func<T, Task>)

ObjectExtensions.TryCastAndRunAsync<T, R>(object?, Func<T, Task<R>>)

ObjectExtensions.TryCastAndRun<T>(object?, Action<T>)

ObjectExtensions.TryCastAndRun<T, R>(object?, Func<T, R>)

Constructors

PersistentSettings(ISettings, ISettingsSerializer)

Initialize new PersistentSettings instance.

protected PersistentSettings(ISettings template, ISettingsSerializer serializer)

Parameters

template ISettings

Template settings to initialize values.

serializer ISettingsSerializer

Settings serializer.

PersistentSettings(ISettingsSerializer)

Initialize new PersistentSettings instance.

protected PersistentSettings(ISettingsSerializer serializer)

Parameters

serializer ISettingsSerializer

Settings serializer.

Properties

Keys

Get all setting keys.

public IEnumerable<SettingKey> Keys { get; }

Property Value

IEnumerable<SettingKey>

Version

Get version of settings.

public abstract int Version { get; }

Property Value

int

Methods

GetRawValue(SettingKey)

Get raw value stored in settings no matter what type of value specified by key.

public object? GetRawValue(SettingKey key)

Parameters

key SettingKey

Key of setting.

Returns

object

Raw setting value.

Load(Stream)

Load settings from given stream synchronously.

public void Load(Stream stream)

Parameters

stream Stream

Stream to load settings from.

Load(string)

Load settings from file synchronously.

public void Load(string fileName)

Parameters

fileName string

Name of file to load settings from.

LoadAsync(Stream)

Load settings from given stream asynchronously.

public Task LoadAsync(Stream stream)

Parameters

stream Stream

Stream to load settings from.

Returns

Task

Task of asynchronous operation.

LoadAsync(string)

Load settings from file asynchronously.

public Task LoadAsync(string fileName)

Parameters

fileName string

Name of file to load settings from.

Returns

Task

Task of asynchronous operation.

OnUpgrade(int)

Called to upgrade settings.

protected abstract void OnUpgrade(int oldVersion)

Parameters

oldVersion int

Old version to upgrade from.

ResetValue(SettingKey)

Reset setting to default value.

public void ResetValue(SettingKey key)

Parameters

key SettingKey

Key of setting.

Save(Stream)

Save settings to given stream synchronously.

public void Save(Stream stream)

Parameters

stream Stream

Stream to save settings.

Save(string)

Save settings to file synchronously.

public void Save(string fileName)

Parameters

fileName string

Name of file to save settings.

SaveAsync(Stream)

Save settings to given stream asynchronously.

public Task SaveAsync(Stream stream)

Parameters

stream Stream

Stream to save settings.

Returns

Task

Task of asynchronous operation.

SaveAsync(string)

Save settings to file asynchronously.

public Task SaveAsync(string fileName)

Parameters

fileName string

Name of file to save settings.

Returns

Task

Task of asynchronous operation.

SetValue(SettingKey, object)

Set value of setting.

[Obsolete("Try using generic SetValue() instead, unless you don't know the type of value.")]
public void SetValue(SettingKey key, object value)

Parameters

key SettingKey

Key og setting.

value object

New value.

Events

SettingChanged

Raised after changing setting.

public event EventHandler<SettingChangedEventArgs>? SettingChanged

Event Type

EventHandler<SettingChangedEventArgs>

SettingChanging

Raised before changing setting.

public event EventHandler<SettingChangingEventArgs>? SettingChanging

Event Type

EventHandler<SettingChangingEventArgs>