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.

242 lines
12 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>Struct Utils.ScopeGuardObject
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Struct Utils.ScopeGuardObject
  11. ">
  12. <meta name="generator" content="docfx 2.48.0.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.Utilities.Utils.ScopeGuardObject">
  75. <h1 id="IPA_Utilities_Utils_ScopeGuardObject" data-uid="IPA.Utilities.Utils.ScopeGuardObject" class="text-break">Struct Utils.ScopeGuardObject
  76. </h1>
  77. <div class="markdown level0 summary"><p>An object used to manage scope guards.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div classs="implements">
  81. <h5>Implements</h5>
  82. <div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
  83. </div>
  84. <div class="inheritedMembers">
  85. <h5>Inherited Members</h5>
  86. <div>
  87. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.valuetype.equals#System_ValueType_Equals_System_Object_">ValueType.Equals(Object)</a>
  88. </div>
  89. <div>
  90. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.valuetype.gethashcode#System_ValueType_GetHashCode">ValueType.GetHashCode()</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.valuetype.tostring#System_ValueType_ToString">ValueType.ToString()</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_System_Object_">Object.Equals(Object, Object)</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#System_Object_ReferenceEquals_System_Object_System_Object_">Object.ReferenceEquals(Object, Object)</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  103. </div>
  104. </div>
  105. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Utilities.html">IPA.Utilities</a></h6>
  106. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  107. <h5 id="IPA_Utilities_Utils_ScopeGuardObject_syntax">Syntax</h5>
  108. <div class="codewrapper">
  109. <pre><code class="lang-csharp hljs">public struct ScopeGuardObject : IDisposable</code></pre>
  110. </div>
  111. <h5 id="IPA_Utilities_Utils_ScopeGuardObject_examples"><strong>Examples</strong></h5>
  112. <pre><code>using var _ = new Utils.ScopeGuardObject(() => RunOnScopeExit(value));</code></pre>
  113. <h3 id="constructors">Constructors
  114. </h3>
  115. <span class="small pull-right mobile-hide">
  116. <span class="divider">|</span>
  117. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Utils_ScopeGuardObject__ctor_System_Action_.md&amp;value=---%0Auid%3A%20IPA.Utilities.Utils.ScopeGuardObject.%23ctor(System.Action)%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>
  118. </span>
  119. <span class="small pull-right mobile-hide">
  120. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/86b96194e3d776008bd15e23a7106308b62bd185/IPA.Loader/Utilities/Utils.cs/#L207">View Source</a>
  121. </span>
  122. <a id="IPA_Utilities_Utils_ScopeGuardObject__ctor_" data-uid="IPA.Utilities.Utils.ScopeGuardObject.#ctor*"></a>
  123. <h4 id="IPA_Utilities_Utils_ScopeGuardObject__ctor_System_Action_" data-uid="IPA.Utilities.Utils.ScopeGuardObject.#ctor(System.Action)">ScopeGuardObject(Action)</h4>
  124. <div class="markdown level1 summary"><p>Creates a new scope guard that will invoke <code data-dev-comment-type="paramref" class="paramref">action</code> when disposed.</p>
  125. </div>
  126. <div class="markdown level1 conceptual"></div>
  127. <h5 class="decalaration">Declaration</h5>
  128. <div class="codewrapper">
  129. <pre><code class="lang-csharp hljs">public ScopeGuardObject(Action action)</code></pre>
  130. </div>
  131. <h5 class="parameters">Parameters</h5>
  132. <table class="table table-bordered table-striped table-condensed">
  133. <thead>
  134. <tr>
  135. <th>Type</th>
  136. <th>Name</th>
  137. <th>Description</th>
  138. </tr>
  139. </thead>
  140. <tbody>
  141. <tr>
  142. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.action">Action</a></td>
  143. <td><span class="parametername">action</span></td>
  144. <td><p>the action to run on dispose</p>
  145. </td>
  146. </tr>
  147. </tbody>
  148. </table>
  149. <h3 id="eii">Explicit Interface Implementations
  150. </h3>
  151. <span class="small pull-right mobile-hide">
  152. <span class="divider">|</span>
  153. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Utils_ScopeGuardObject_System_IDisposable_Dispose.md&amp;value=---%0Auid%3A%20IPA.Utilities.Utils.ScopeGuardObject.System%23IDisposable%23Dispose%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>
  154. </span>
  155. <span class="small pull-right mobile-hide">
  156. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/86b96194e3d776008bd15e23a7106308b62bd185/IPA.Loader/Utilities/Utils.cs/#L209">View Source</a>
  157. </span>
  158. <a id="IPA_Utilities_Utils_ScopeGuardObject_System_IDisposable_Dispose_" data-uid="IPA.Utilities.Utils.ScopeGuardObject.System#IDisposable#Dispose*"></a>
  159. <h4 id="IPA_Utilities_Utils_ScopeGuardObject_System_IDisposable_Dispose" data-uid="IPA.Utilities.Utils.ScopeGuardObject.System#IDisposable#Dispose">IDisposable.Dispose()</h4>
  160. <div class="markdown level1 summary"></div>
  161. <div class="markdown level1 conceptual"></div>
  162. <h5 class="decalaration">Declaration</h5>
  163. <div class="codewrapper">
  164. <pre><code class="lang-csharp hljs">void IDisposable.Dispose()</code></pre>
  165. </div>
  166. <h3 id="implements">Implements</h3>
  167. <div>
  168. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">System.IDisposable</a>
  169. </div>
  170. <h3 id="extensionmethods">Extension Methods</h3>
  171. <div>
  172. <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>
  173. </div>
  174. <div>
  175. <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>
  176. </div>
  177. <div>
  178. <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>
  179. </div>
  180. <div>
  181. <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>
  182. </div>
  183. <div>
  184. <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>
  185. </div>
  186. <h3 id="seealso">See Also</h3>
  187. <div class="seealso">
  188. <div><a class="xref" href="IPA.Utilities.Utils.html#IPA_Utilities_Utils_ScopeGuard_System_Action_">ScopeGuard(Action)</a></div>
  189. </div>
  190. </article>
  191. </div>
  192. <div class="hidden-sm col-md-2" role="complementary">
  193. <div class="sideaffix">
  194. <div class="contribution">
  195. <ul class="nav">
  196. <li>
  197. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Utils_ScopeGuardObject.md&amp;value=---%0Auid%3A%20IPA.Utilities.Utils.ScopeGuardObject%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>
  198. </li>
  199. <li>
  200. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/86b96194e3d776008bd15e23a7106308b62bd185/IPA.Loader/Utilities/Utils.cs/#L200" class="contribution-link">View Source</a>
  201. </li>
  202. </ul>
  203. </div>
  204. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  205. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  206. </nav>
  207. </div>
  208. </div>
  209. </div>
  210. </div>
  211. <footer>
  212. <div class="grad-bottom"></div>
  213. <div class="footer">
  214. <div class="container">
  215. <span class="pull-right">
  216. <a href="#top">Back to top</a>
  217. </span>
  218. <span>Generated by <strong>DocFX</strong></span>
  219. </div>
  220. </div>
  221. </footer>
  222. </div>
  223. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  224. <script type="text/javascript" src="../styles/docfx.js"></script>
  225. <script type="text/javascript" src="../styles/main.js"></script>
  226. </body>
  227. </html>