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.

199 lines
14 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> </title>
  8. <meta name="viewport" content="width=device-width">
  9. <meta name="title" content=" ">
  10. <meta name="generator" content="docfx 2.59.4.0">
  11. <link rel="shortcut icon" href="../favicon.ico">
  12. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  13. <link rel="stylesheet" href="../styles/docfx.css">
  14. <link rel="stylesheet" href="../styles/main.css">
  15. <link rel="stylesheet" href="../styles/fix.css">
  16. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. <meta property="docfx:newtab" content="true">
  21. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="IPA.Config.Stores.Converters">
  73. <h1 id="IPA_Config_Stores_Converters" data-uid="IPA.Config.Stores.Converters" class="text-break"></h1>
  74. <div class="markdown level0 summary"></div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="markdown level0 remarks"></div>
  77. <h3 id="classes">Classes
  78. </h3>
  79. <h4><a class="xref" href="IPA.Config.Stores.Converters.CaseInsensitiveEnumConverter-1.html">CaseInsensitiveEnumConverter&lt;T&gt;</a></h4>
  80. <section><p>A converter for an enum of type <code data-dev-comment-type="typeparamref" class="typeparamref">T</code>, that converts the enum to its string representation and back,
  81. ignoring the case of the serialized value for deseiralization.</p>
  82. </section>
  83. <h4><a class="xref" href="IPA.Config.Stores.Converters.CollectionConverter-2.html">CollectionConverter&lt;T, TCollection&gt;</a></h4>
  84. <section><p>A base class for all <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.icollection-1">ICollection&lt;T&gt;</a> type converters, providing most of the functionality.</p>
  85. </section>
  86. <h4><a class="xref" href="IPA.Config.Stores.Converters.CollectionConverter-3.html">CollectionConverter&lt;T, TCollection, TConverter&gt;</a></h4>
  87. <section><p>A <a class="xref" href="IPA.Config.Stores.Converters.CollectionConverter-2.html">CollectionConverter&lt;T, TCollection&gt;</a> which default constructs a converter for use as the value converter.</p>
  88. </section>
  89. <h4><a class="xref" href="IPA.Config.Stores.Converters.Converter.html">Converter</a></h4>
  90. <section><p>Provides utility functions for custom converters.</p>
  91. </section>
  92. <h4><a class="xref" href="IPA.Config.Stores.Converters.Converter-1.html">Converter&lt;T&gt;</a></h4>
  93. <section><p>Provides generic utilities for converters for certain types.</p>
  94. </section>
  95. <h4><a class="xref" href="IPA.Config.Stores.Converters.CustomObjectConverter-1.html">CustomObjectConverter&lt;T&gt;</a></h4>
  96. <section><p>A <a class="xref" href="IPA.Config.Stores.ValueConverter-1.html">ValueConverter&lt;T&gt;</a> for objects normally serialized to config via <a class="xref" href="IPA.Config.Stores.GeneratedStore.html#IPA_Config_Stores_GeneratedStore_Generated__1_IPA_Config_Config_System_Boolean_">Generated&lt;T&gt;(Config, Boolean)</a>.</p>
  97. </section>
  98. <h4><a class="xref" href="IPA.Config.Stores.Converters.CustomValueTypeConverter-1.html">CustomValueTypeConverter&lt;T&gt;</a></h4>
  99. <section><p>A <a class="xref" href="IPA.Config.Stores.ValueConverter-1.html">ValueConverter&lt;T&gt;</a> for custom value types, serialized identically to the reference types serialized with
  100. <a class="xref" href="IPA.Config.Stores.GeneratedStore.html#IPA_Config_Stores_GeneratedStore_Generated__1_IPA_Config_Config_System_Boolean_">Generated&lt;T&gt;(Config, Boolean)</a>.</p>
  101. </section>
  102. <h4><a class="xref" href="IPA.Config.Stores.Converters.DictionaryConverter-1.html">DictionaryConverter&lt;TValue&gt;</a></h4>
  103. <section><p>A converter for instances of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary&lt;TKey,TValue&gt;</a>.</p>
  104. </section>
  105. <h4><a class="xref" href="IPA.Config.Stores.Converters.DictionaryConverter-2.html">DictionaryConverter&lt;TValue, TConverter&gt;</a></h4>
  106. <section><p>A converter for instances of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.dictionary-2">Dictionary&lt;TKey,TValue&gt;</a>, specifying a value converter as a type parameter.</p>
  107. </section>
  108. <h4><a class="xref" href="IPA.Config.Stores.Converters.EnumConverter-1.html">EnumConverter&lt;T&gt;</a></h4>
  109. <section><p>A converter for an enum of type <code data-dev-comment-type="typeparamref" class="typeparamref">T</code>, that converts the enum to its string representation and back.</p>
  110. </section>
  111. <h4><a class="xref" href="IPA.Config.Stores.Converters.HexColorConverter.html">HexColorConverter</a></h4>
  112. <section><p>A converter for <span class="xref">UnityEngine.Color</span> objects.</p>
  113. </section>
  114. <h4><a class="xref" href="IPA.Config.Stores.Converters.IDictionaryConverter-1.html">IDictionaryConverter&lt;TValue&gt;</a></h4>
  115. <section><p>A converter for instances of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.idictionary-2">IDictionary&lt;TKey,TValue&gt;</a>.</p>
  116. </section>
  117. <h4><a class="xref" href="IPA.Config.Stores.Converters.IDictionaryConverter-2.html">IDictionaryConverter&lt;TValue, TConverter&gt;</a></h4>
  118. <section><p>A converter for instances of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.idictionary-2">IDictionary&lt;TKey,TValue&gt;</a>, specifying a value converter as a type parameter.</p>
  119. </section>
  120. <h4><a class="xref" href="IPA.Config.Stores.Converters.IListConverter-1.html">IListConverter&lt;T&gt;</a></h4>
  121. <section><p>A <a class="xref" href="IPA.Config.Stores.Converters.CollectionConverter-2.html">CollectionConverter&lt;T, TCollection&gt;</a> for an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList&lt;T&gt;</a>, creating a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List&lt;T&gt;</a> when deserializing.</p>
  122. </section>
  123. <h4><a class="xref" href="IPA.Config.Stores.Converters.IListConverter-2.html">IListConverter&lt;T, TConverter&gt;</a></h4>
  124. <section><p>An <a class="xref" href="IPA.Config.Stores.Converters.IListConverter-1.html">IListConverter&lt;T&gt;</a> which default constructs a converter for use as the value converter.</p>
  125. </section>
  126. <h4><a class="xref" href="IPA.Config.Stores.Converters.IReadOnlyDictionaryConverter-1.html">IReadOnlyDictionaryConverter&lt;TValue&gt;</a></h4>
  127. <section><p>A converter for instances of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlydictionary-2">IReadOnlyDictionary&lt;TKey,TValue&gt;</a>.</p>
  128. </section>
  129. <h4><a class="xref" href="IPA.Config.Stores.Converters.IReadOnlyDictionaryConverter-2.html">IReadOnlyDictionaryConverter&lt;TValue, TConverter&gt;</a></h4>
  130. <section><p>A converter for instances of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlydictionary-2">IReadOnlyDictionary&lt;TKey,TValue&gt;</a>, specifying a value converter as a type parameter.</p>
  131. </section>
  132. <h4><a class="xref" href="IPA.Config.Stores.Converters.ISetConverter-1.html">ISetConverter&lt;T&gt;</a></h4>
  133. <section><p>A <a class="xref" href="IPA.Config.Stores.Converters.CollectionConverter-2.html">CollectionConverter&lt;T, TCollection&gt;</a> for an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iset-1">ISet&lt;T&gt;</a>, creating a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.hashset-1">HashSet&lt;T&gt;</a> when deserializing.</p>
  134. </section>
  135. <h4><a class="xref" href="IPA.Config.Stores.Converters.ISetConverter-2.html">ISetConverter&lt;T, TConverter&gt;</a></h4>
  136. <section><p>An <a class="xref" href="IPA.Config.Stores.Converters.ISetConverter-1.html">ISetConverter&lt;T&gt;</a> which default constructs a converter for use as the value converter.</p>
  137. </section>
  138. <h4><a class="xref" href="IPA.Config.Stores.Converters.ListConverter-1.html">ListConverter&lt;T&gt;</a></h4>
  139. <section><p>A <a class="xref" href="IPA.Config.Stores.Converters.CollectionConverter-2.html">CollectionConverter&lt;T, TCollection&gt;</a> for a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List&lt;T&gt;</a>.</p>
  140. </section>
  141. <h4><a class="xref" href="IPA.Config.Stores.Converters.ListConverter-2.html">ListConverter&lt;T, TConverter&gt;</a></h4>
  142. <section><p>A <a class="xref" href="IPA.Config.Stores.Converters.ListConverter-1.html">ListConverter&lt;T&gt;</a> which default constructs a converter for use as the value converter.</p>
  143. </section>
  144. <h4><a class="xref" href="IPA.Config.Stores.Converters.NullableConverter-1.html">NullableConverter&lt;T&gt;</a></h4>
  145. <section><p>A converter for a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable&lt;T&gt;</a>.</p>
  146. </section>
  147. <h4><a class="xref" href="IPA.Config.Stores.Converters.NullableConverter-2.html">NullableConverter&lt;T, TConverter&gt;</a></h4>
  148. <section><p>A converter for a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable&lt;T&gt;</a> that default-constructs a converter of type <code data-dev-comment-type="typeparamref" class="typeparamref">TConverter</code>
  149. to use as the underlying converter. Use this in the <a class="xref" href="IPA.Config.Stores.Attributes.UseConverterAttribute.html">UseConverterAttribute</a>.</p>
  150. </section>
  151. <h4><a class="xref" href="IPA.Config.Stores.Converters.NumericEnumConverter-1.html">NumericEnumConverter&lt;T&gt;</a></h4>
  152. <section><p>A converter for an enum of type <code data-dev-comment-type="typeparamref" class="typeparamref">T</code>, that converts the enum to its underlying value for serialization.</p>
  153. </section>
  154. </article>
  155. </div>
  156. <div class="hidden-sm col-md-2" role="complementary">
  157. <div class="sideaffix">
  158. <div class="contribution">
  159. <ul class="nav">
  160. </ul>
  161. </div>
  162. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  163. <h5>In This Article</h5>
  164. <div></div>
  165. </nav>
  166. </div>
  167. </div>
  168. </div>
  169. </div>
  170. <footer>
  171. <div class="grad-bottom"></div>
  172. <div class="footer">
  173. <div class="container">
  174. <span class="pull-right">
  175. <a href="#top">Back to top</a>
  176. </span>
  177. <span>Generated by <strong>DocFX</strong></span>
  178. </div>
  179. </div>
  180. </footer>
  181. </div>
  182. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  183. <script type="text/javascript" src="../styles/docfx.js"></script>
  184. <script type="text/javascript" src="../styles/main.js"></script>
  185. </body>
  186. </html>