lib/VNLib.Plugins.Extensions.Loading/src/Configuration/IConfigScope.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

/*
* Copyright (c) 2023 Vaughn Nugent
* 
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Loading
* File: IConfigScope.cs 
*
* IConfigScope.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger 
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Loading is free software: you can redistribute it and/or modify 
* it under the terms of the GNU Affero General Public License as 
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Extensions.Loading is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program.  If not, see https://www.gnu.org/licenses/.
*/

using System.Text.Json;
using System.Collections.Generic;

namespace VNLib.Plugins.Extensions.Loading
{
    /// <summary>
    /// A top-level scoped configuration element
    /// </summary>
    public interface IConfigScope : IReadOnlyDictionary<string, JsonElement>
    {
        /// <summary>
        /// The root level name of the configuration element
        /// </summary>
        string ScopeName { get; }

        /// <summary>
        /// Json deserialzes the current config scope to the desired type
        /// </summary>
        /// <typeparam name="T">The type to deserialze the current config to</typeparam>
        /// <returns>The instance created from the current scope</returns>
        T Deserialze<T>();
    }
}