DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git

﻿<!DOCTYPE html><!--[if IE]><![endif]--><html>    <head>    <meta charset="utf-8">    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">    <title>Interface IConfigProvider   </title>    <meta name="viewport" content="width=device-width">    <meta name="title" content="Interface IConfigProvider   ">    <meta name="generator" content="docfx 2.59.4.0">        <link rel="shortcut icon" href="../favicon.ico">    <link rel="stylesheet" href="../styles/docfx.vendor.css">    <link rel="stylesheet" href="../styles/docfx.css">    <link rel="stylesheet" href="../styles/main.css">    <link rel="stylesheet" href="../styles/fix.css">    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">     <meta property="docfx:navrel" content="../toc.html">    <meta property="docfx:tocrel" content="toc.html">        <meta property="docfx:rel" content="../">    <meta property="docfx:newtab" content="true">  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">    <div id="wrapper">      <header>                <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">          <div class="container">            <div class="navbar-header">              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">                <span class="sr-only">Toggle navigation</span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>              </button>                            <a class="navbar-brand" href="../index.html">                <img id="logo" class="svg" src="../logo.svg" alt="">              </a>            </div>            <div class="collapse navbar-collapse" id="navbar">              <form class="navbar-form navbar-right" role="search" id="search">                <div class="form-group">                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">                </div>              </form>            </div>          </div>        </nav>                <div class="subnav navbar navbar-default">          <div class="container hide-when-search" id="breadcrumb">            <ul class="breadcrumb">              <li></li>            </ul>          </div>        </div>      </header>      <div class="container body-content">                <div id="search-results">          <div class="search-list">Search Results for <span></span></div>          <div class="sr-items">            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>          </div>          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>        </div>      </div>      <div role="main" class="container body-content hide-when-search">                <div class="sidenav hide-when-search">          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>          <div class="sidetoggle collapse" id="sidetoggle">            <div id="sidetoc"></div>          </div>        </div>        <div class="article row grid-right">          <div class="col-md-10">            <article class="content wrap" id="_content" data-uid="IPA.Config.IConfigProvider">      <h1 id="IPA_Config_IConfigProvider" data-uid="IPA.Config.IConfigProvider" class="text-break">Interface IConfigProvider  </h1>  <div class="markdown level0 summary"><p>An interface for configuration providers.</p></div>  <div class="markdown level0 conceptual"></div>  <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.html">IPA.Config</a></h6>  <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>  <h5 id="IPA_Config_IConfigProvider_syntax">Syntax</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public interface IConfigProvider</code></pre>  </div>  <h5 id="IPA_Config_IConfigProvider_remarks"><strong>Remarks</strong></h5>  <div class="markdown level0 remarks"><p>Implementers must provide a default constructor. Do not assume that <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.file">File</a> will ever be set for a given object.</p><p>Implementers are expected to preserve the typing of values passed to <a class="xref" href="IPA.Config.IConfigProvider.html#IPA_Config_IConfigProvider_Store_IPA_Config_Data_Value_System_IO_FileInfo_">Store(Value, FileInfo)</a> when returned from <a class="xref" href="IPA.Config.IConfigProvider.html#IPA_Config_IConfigProvider_Load_System_IO_FileInfo_">Load(FileInfo)</a>.The only exceptions to this are the numeric types, <a class="xref" href="IPA.Config.Data.Integer.html">Integer</a> and <a class="xref" href="IPA.Config.Data.FloatingPoint.html">FloatingPoint</a>, since they can be coercedto each other with <a class="xref" href="IPA.Config.Data.Integer.html#IPA_Config_Data_Integer_AsFloat">AsFloat()</a> and <a class="xref" href="IPA.Config.Data.FloatingPoint.html#IPA_Config_Data_FloatingPoint_AsInteger">AsInteger()</a> respectively. The provider <em>should</em>however store and recover <a class="xref" href="IPA.Config.Data.Integer.html">Integer</a> with as much precision as is possible. For example, a JSON provider may decide todecode all numbers that have an integral value, even if they were originally <a class="xref" href="IPA.Config.Data.FloatingPoint.html">FloatingPoint</a>, as <a class="xref" href="IPA.Config.Data.Integer.html">Integer</a>.This is reasonable, as <a class="xref" href="IPA.Config.Data.Integer.html">Integer</a> is more precise, particularly with larger values, than <a class="xref" href="IPA.Config.Data.FloatingPoint.html">FloatingPoint</a>.</p></div>  <h3 id="properties">Properties  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/monomod-reorg/docs/override/new?filename=IPA_Config_IConfigProvider_Extension.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigProvider.Extension%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a0bf0a5dee2600ecb36d727d9672e34580d62b86/IPA.Loader/Config/IConfigProvider.cs/#L33">View Source</a>  </span>  <a id="IPA_Config_IConfigProvider_Extension_" data-uid="IPA.Config.IConfigProvider.Extension*"></a>  <h4 id="IPA_Config_IConfigProvider_Extension" data-uid="IPA.Config.IConfigProvider.Extension">Extension</h4>  <div class="markdown level1 summary"><p>Gets the extension <em>without</em> a dot to use for files handled by this provider.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">string Extension { get; }</code></pre>  </div>  <h5 class="propertyValue">Property Value</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>        <td></td>      </tr>    </tbody>  </table>  <h5 id="IPA_Config_IConfigProvider_Extension_remarks">Remarks</h5>  <div class="markdown level1 remarks"><p>This must work immediately, and is used to generate the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a> used to set<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.file">File</a>.</p></div>  <h3 id="methods">Methods  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/monomod-reorg/docs/override/new?filename=IPA_Config_IConfigProvider_Load_System_IO_FileInfo_.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigProvider.Load(System.IO.FileInfo)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a0bf0a5dee2600ecb36d727d9672e34580d62b86/IPA.Loader/Config/IConfigProvider.cs/#L48">View Source</a>  </span>  <a id="IPA_Config_IConfigProvider_Load_" data-uid="IPA.Config.IConfigProvider.Load*"></a>  <h4 id="IPA_Config_IConfigProvider_Load_System_IO_FileInfo_" data-uid="IPA.Config.IConfigProvider.Load(System.IO.FileInfo)">Load(FileInfo)</h4>  <div class="markdown level1 summary"><p>Loads a <a class="xref" href="IPA.Config.Data.Value.html">Value</a> from disk in whatever format this provider providesand returns it.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">Value Load(FileInfo file)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a></td>        <td><span class="parametername">file</span></td>        <td><p>the file to read from</p></td>      </tr>    </tbody>  </table>  <h5 class="returns">Returns</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>        <td><p>the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> loaded</p></td>      </tr>    </tbody>  </table>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/monomod-reorg/docs/override/new?filename=IPA_Config_IConfigProvider_Store_IPA_Config_Data_Value_System_IO_FileInfo_.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigProvider.Store(IPA.Config.Data.Value%2CSystem.IO.FileInfo)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a0bf0a5dee2600ecb36d727d9672e34580d62b86/IPA.Loader/Config/IConfigProvider.cs/#L40">View Source</a>  </span>  <a id="IPA_Config_IConfigProvider_Store_" data-uid="IPA.Config.IConfigProvider.Store*"></a>  <h4 id="IPA_Config_IConfigProvider_Store_IPA_Config_Data_Value_System_IO_FileInfo_" data-uid="IPA.Config.IConfigProvider.Store(IPA.Config.Data.Value,System.IO.FileInfo)">Store(Value, FileInfo)</h4>  <div class="markdown level1 summary"><p>Stores the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> given to disk in the format specified.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">void Store(Value value, FileInfo file)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>        <td><span class="parametername">value</span></td>        <td><p>the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> to store</p></td>      </tr>      <tr>        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a></td>        <td><span class="parametername">file</span></td>        <td><p>the file to write to</p></td>      </tr>    </tbody>  </table>  <h3 id="extensionmethods">Extension Methods</h3>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField&lt;T, U&gt;(T, String, U)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;U, T&gt;(T, String)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty&lt;T, U&gt;(T, String, U)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty&lt;U, T&gt;(T, String)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;U, T&gt;(T, String, Object[])</a>  </div></article>          </div>                    <div class="hidden-sm col-md-2" role="complementary">            <div class="sideaffix">              <div class="contribution">                <ul class="nav">                  <li>                    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/monomod-reorg/docs/override/new?filename=IPA_Config_IConfigProvider.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigProvider%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>                  </li>                  <li>                    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/a0bf0a5dee2600ecb36d727d9672e34580d62b86/IPA.Loader/Config/IConfigProvider.cs/#L24" class="contribution-link">View Source</a>                  </li>                </ul>              </div>              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">                <h5>In This Article</h5>                <div></div>              </nav>            </div>          </div>        </div>      </div>            <footer>        <div class="grad-bottom"></div>        <div class="footer">          <div class="container">            <span class="pull-right">              <a href="#top">Back to top</a>            </span>                        <span>Generated by <strong>DocFX</strong></span>          </div>        </div>      </footer>    </div>        <script type="text/javascript" src="../styles/docfx.vendor.js"></script>    <script type="text/javascript" src="../styles/docfx.js"></script>    <script type="text/javascript" src="../styles/main.js"></script>  </body></html>