GFramework/GFramework.Game.Abstractions/setting/ISettingsPersistence.cs

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using GFramework.Core.Abstractions.utility;

namespace GFramework.Game.Abstractions.setting;

/// <summary>
/// 设置持久化接口
/// 定义了设置数据的异步加载、保存、检查存在性和删除操作
/// </summary>
public interface ISettingsPersistence : IContextUtility
{
    /// <summary>
    /// 异步加载指定类型的设置数据
    /// </summary>
    Task<T> LoadAsync<T>() where T : class, ISettingsData, new();

    /// <summary>
    /// 异步保存指定的设置数据
    /// </summary>
    Task SaveAsync<T>(T section) where T : class, ISettingsData;

    /// <summary>
    /// 异步检查指定类型的设置数据是否存在
    /// </summary>
    Task<bool> ExistsAsync<T>() where T : class, ISettingsData;

    /// <summary>
    /// 异步删除指定类型的设置数据
    /// </summary>
    Task DeleteAsync<T>() where T : class, ISettingsData;

    /// <summary>
    /// 保存所有设置数据
    /// </summary>
    Task SaveAllAsync(IEnumerable<ISettingsData> allData);

    /// <summary>
    /// 加载所有已知类型的设置数据
    /// </summary>
    Task<IDictionary<Type, ISettingsData>> LoadAllAsync(IEnumerable<Type> knownTypes);

    /// <summary>
    /// 重置指定类型的设置数据为默认值
    /// </summary>
    Task<T> ResetAsync<T>() where T : class, ISettingsData, new();

    /// <summary>
    /// 重置所有设置数据为默认值
    /// </summary>
    Task ResetAllAsync();
}