You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

305 lines
16 KiB

  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Interface IConfigStore
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Interface IConfigStore
  11. ">
  12. <meta name="generator" content="docfx 2.48.1.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <link rel="stylesheet" href="../styles/fix.css">
  18. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../">
  22. <meta property="docfx:newtab" content="true">
  23. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  24. <div id="wrapper">
  25. <header>
  26. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  27. <div class="container">
  28. <div class="navbar-header">
  29. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  30. <span class="sr-only">Toggle navigation</span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. <span class="icon-bar"></span>
  34. </button>
  35. <a class="navbar-brand" href="../index.html">
  36. <img id="logo" class="svg" src="../logo.svg" alt="">
  37. </a>
  38. </div>
  39. <div class="collapse navbar-collapse" id="navbar">
  40. <form class="navbar-form navbar-right" role="search" id="search">
  41. <div class="form-group">
  42. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  43. </div>
  44. </form>
  45. </div>
  46. </div>
  47. </nav>
  48. <div class="subnav navbar navbar-default">
  49. <div class="container hide-when-search" id="breadcrumb">
  50. <ul class="breadcrumb">
  51. <li></li>
  52. </ul>
  53. </div>
  54. </div>
  55. </header>
  56. <div class="container body-content">
  57. <div id="search-results">
  58. <div class="search-list"></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination"></ul>
  63. </div>
  64. </div>
  65. <div role="main" class="container body-content hide-when-search">
  66. <div class="sidenav hide-when-search">
  67. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  68. <div class="sidetoggle collapse" id="sidetoggle">
  69. <div id="sidetoc"></div>
  70. </div>
  71. </div>
  72. <div class="article row grid-right">
  73. <div class="col-md-10">
  74. <article class="content wrap" id="_content" data-uid="IPA.Config.IConfigStore">
  75. <h1 id="IPA_Config_IConfigStore" data-uid="IPA.Config.IConfigStore" class="text-break">Interface IConfigStore
  76. </h1>
  77. <div class="markdown level0 summary"><p>A storage for a config structure.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.html">IPA.Config</a></h6>
  81. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  82. <h5 id="IPA_Config_IConfigStore_syntax">Syntax</h5>
  83. <div class="codewrapper">
  84. <pre><code class="lang-csharp hljs">public interface IConfigStore</code></pre>
  85. </div>
  86. <h3 id="properties">Properties
  87. </h3>
  88. <span class="small pull-right mobile-hide">
  89. <span class="divider">|</span>
  90. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_IConfigStore_SyncObject.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigStore.SyncObject%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>
  91. </span>
  92. <span class="small pull-right mobile-hide">
  93. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/cdf2021608975e231005604c9e2ae874e57d5b60/IPA.Loader/Config/IConfigStore.cs/#L21">View Source</a>
  94. </span>
  95. <a id="IPA_Config_IConfigStore_SyncObject_" data-uid="IPA.Config.IConfigStore.SyncObject*"></a>
  96. <h4 id="IPA_Config_IConfigStore_SyncObject" data-uid="IPA.Config.IConfigStore.SyncObject">SyncObject</h4>
  97. <div class="markdown level1 summary"><p>A synchronization object for the save thread to wait on for changes.
  98. It should be signaled whenever the internal state of the object is changed.
  99. The writer will never signal this handle. </p>
  100. </div>
  101. <div class="markdown level1 conceptual"></div>
  102. <h5 class="decalaration">Declaration</h5>
  103. <div class="codewrapper">
  104. <pre><code class="lang-csharp hljs">WaitHandle SyncObject { get; }</code></pre>
  105. </div>
  106. <h5 class="propertyValue">Property Value</h5>
  107. <table class="table table-bordered table-striped table-condensed">
  108. <thead>
  109. <tr>
  110. <th>Type</th>
  111. <th>Description</th>
  112. </tr>
  113. </thead>
  114. <tbody>
  115. <tr>
  116. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.waithandle">WaitHandle</a></td>
  117. <td></td>
  118. </tr>
  119. </tbody>
  120. </table>
  121. <span class="small pull-right mobile-hide">
  122. <span class="divider">|</span>
  123. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_IConfigStore_WriteSyncObject.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigStore.WriteSyncObject%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>
  124. </span>
  125. <span class="small pull-right mobile-hide">
  126. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/cdf2021608975e231005604c9e2ae874e57d5b60/IPA.Loader/Config/IConfigStore.cs/#L32">View Source</a>
  127. </span>
  128. <a id="IPA_Config_IConfigStore_WriteSyncObject_" data-uid="IPA.Config.IConfigStore.WriteSyncObject*"></a>
  129. <h4 id="IPA_Config_IConfigStore_WriteSyncObject" data-uid="IPA.Config.IConfigStore.WriteSyncObject">WriteSyncObject</h4>
  130. <div class="markdown level1 summary"><p>A synchronization object for the load thread and accessors to maintain safe synchronization.
  131. Any readers should take a read lock with <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.readerwriterlockslim.enterreadlock#System_Threading_ReaderWriterLockSlim_EnterReadLock">EnterReadLock()</a> or
  132. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.readerwriterlockslim.enterupgradeablereadlock#System_Threading_ReaderWriterLockSlim_EnterUpgradeableReadLock">EnterUpgradeableReadLock()</a>, and any writers should take a
  133. write lock with <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.readerwriterlockslim.enterwritelock#System_Threading_ReaderWriterLockSlim_EnterWriteLock">EnterWriteLock()</a>.</p>
  134. </div>
  135. <div class="markdown level1 conceptual"></div>
  136. <h5 class="decalaration">Declaration</h5>
  137. <div class="codewrapper">
  138. <pre><code class="lang-csharp hljs">ReaderWriterLockSlim WriteSyncObject { get; }</code></pre>
  139. </div>
  140. <h5 class="propertyValue">Property Value</h5>
  141. <table class="table table-bordered table-striped table-condensed">
  142. <thead>
  143. <tr>
  144. <th>Type</th>
  145. <th>Description</th>
  146. </tr>
  147. </thead>
  148. <tbody>
  149. <tr>
  150. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.readerwriterlockslim">ReaderWriterLockSlim</a></td>
  151. <td></td>
  152. </tr>
  153. </tbody>
  154. </table>
  155. <h5 id="IPA_Config_IConfigStore_WriteSyncObject_remarks">Remarks</h5>
  156. <div class="markdown level1 remarks"><p>Read and write are read and write to <em>this object</em>, not to the file on disk.</p>
  157. </div>
  158. <h3 id="methods">Methods
  159. </h3>
  160. <span class="small pull-right mobile-hide">
  161. <span class="divider">|</span>
  162. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_IConfigStore_ReadFrom_IPA_Config_ConfigProvider_.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigStore.ReadFrom(IPA.Config.ConfigProvider)%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>
  163. </span>
  164. <span class="small pull-right mobile-hide">
  165. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/cdf2021608975e231005604c9e2ae874e57d5b60/IPA.Loader/Config/IConfigStore.cs/#L54">View Source</a>
  166. </span>
  167. <a id="IPA_Config_IConfigStore_ReadFrom_" data-uid="IPA.Config.IConfigStore.ReadFrom*"></a>
  168. <h4 id="IPA_Config_IConfigStore_ReadFrom_IPA_Config_ConfigProvider_" data-uid="IPA.Config.IConfigStore.ReadFrom(IPA.Config.ConfigProvider)">ReadFrom(ConfigProvider)</h4>
  169. <div class="markdown level1 summary"><p>Reads the config structure from the given <a class="xref" href="IPA.Config.IConfigProvider.html">IConfigProvider</a> into the current
  170. <a class="xref" href="IPA.Config.IConfigStore.html">IConfigStore</a>.</p>
  171. </div>
  172. <div class="markdown level1 conceptual"></div>
  173. <h5 class="decalaration">Declaration</h5>
  174. <div class="codewrapper">
  175. <pre><code class="lang-csharp hljs">void ReadFrom(ConfigProvider provider)</code></pre>
  176. </div>
  177. <h5 class="parameters">Parameters</h5>
  178. <table class="table table-bordered table-striped table-condensed">
  179. <thead>
  180. <tr>
  181. <th>Type</th>
  182. <th>Name</th>
  183. <th>Description</th>
  184. </tr>
  185. </thead>
  186. <tbody>
  187. <tr>
  188. <td><a class="xref" href="IPA.Config.ConfigProvider.html">ConfigProvider</a></td>
  189. <td><span class="parametername">provider</span></td>
  190. <td><p>the provider to read from</p>
  191. </td>
  192. </tr>
  193. </tbody>
  194. </table>
  195. <h5 id="IPA_Config_IConfigStore_ReadFrom_IPA_Config_ConfigProvider__remarks">Remarks</h5>
  196. <div class="markdown level1 remarks"><p>The calling code will have entered a write lock on <a class="xref" href="IPA.Config.IConfigStore.html#IPA_Config_IConfigStore_WriteSyncObject">WriteSyncObject</a> when
  197. this is called.</p>
  198. </div>
  199. <span class="small pull-right mobile-hide">
  200. <span class="divider">|</span>
  201. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_IConfigStore_WriteTo_IPA_Config_ConfigProvider_.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigStore.WriteTo(IPA.Config.ConfigProvider)%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>
  202. </span>
  203. <span class="small pull-right mobile-hide">
  204. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/cdf2021608975e231005604c9e2ae874e57d5b60/IPA.Loader/Config/IConfigStore.cs/#L43">View Source</a>
  205. </span>
  206. <a id="IPA_Config_IConfigStore_WriteTo_" data-uid="IPA.Config.IConfigStore.WriteTo*"></a>
  207. <h4 id="IPA_Config_IConfigStore_WriteTo_IPA_Config_ConfigProvider_" data-uid="IPA.Config.IConfigStore.WriteTo(IPA.Config.ConfigProvider)">WriteTo(ConfigProvider)</h4>
  208. <div class="markdown level1 summary"><p>Writes the config structure stored by the current <a class="xref" href="IPA.Config.IConfigStore.html">IConfigStore</a> to the given
  209. <a class="xref" href="IPA.Config.IConfigProvider.html">IConfigProvider</a>.</p>
  210. </div>
  211. <div class="markdown level1 conceptual"></div>
  212. <h5 class="decalaration">Declaration</h5>
  213. <div class="codewrapper">
  214. <pre><code class="lang-csharp hljs">void WriteTo(ConfigProvider provider)</code></pre>
  215. </div>
  216. <h5 class="parameters">Parameters</h5>
  217. <table class="table table-bordered table-striped table-condensed">
  218. <thead>
  219. <tr>
  220. <th>Type</th>
  221. <th>Name</th>
  222. <th>Description</th>
  223. </tr>
  224. </thead>
  225. <tbody>
  226. <tr>
  227. <td><a class="xref" href="IPA.Config.ConfigProvider.html">ConfigProvider</a></td>
  228. <td><span class="parametername">provider</span></td>
  229. <td><p>the provider to write to</p>
  230. </td>
  231. </tr>
  232. </tbody>
  233. </table>
  234. <h5 id="IPA_Config_IConfigStore_WriteTo_IPA_Config_ConfigProvider__remarks">Remarks</h5>
  235. <div class="markdown level1 remarks"><p>The calling code will have entered a read lock on <a class="xref" href="IPA.Config.IConfigStore.html#IPA_Config_IConfigStore_WriteSyncObject">WriteSyncObject</a> when
  236. this is called.</p>
  237. </div>
  238. <h3 id="extensionmethods">Extension Methods</h3>
  239. <div>
  240. <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>
  241. </div>
  242. <div>
  243. <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>
  244. </div>
  245. <div>
  246. <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>
  247. </div>
  248. <div>
  249. <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>
  250. </div>
  251. <div>
  252. <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>
  253. </div>
  254. </article>
  255. </div>
  256. <div class="hidden-sm col-md-2" role="complementary">
  257. <div class="sideaffix">
  258. <div class="contribution">
  259. <ul class="nav">
  260. <li>
  261. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_IConfigStore.md&amp;value=---%0Auid%3A%20IPA.Config.IConfigStore%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>
  262. </li>
  263. <li>
  264. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/cdf2021608975e231005604c9e2ae874e57d5b60/IPA.Loader/Config/IConfigStore.cs/#L14" class="contribution-link">View Source</a>
  265. </li>
  266. </ul>
  267. </div>
  268. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  269. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  270. </nav>
  271. </div>
  272. </div>
  273. </div>
  274. </div>
  275. <footer>
  276. <div class="grad-bottom"></div>
  277. <div class="footer">
  278. <div class="container">
  279. <span class="pull-right">
  280. <a href="#top">Back to top</a>
  281. </span>
  282. <span>Generated by <strong>DocFX</strong></span>
  283. </div>
  284. </div>
  285. </footer>
  286. </div>
  287. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  288. <script type="text/javascript" src="../styles/docfx.js"></script>
  289. <script type="text/javascript" src="../styles/main.js"></script>
  290. </body>
  291. </html>