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.

353 lines
19 KiB

11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
11 months ago
  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>Class GZFilePrinter
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class GZFilePrinter
  11. ">
  12. <meta name="generator" content="docfx 2.59.4.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">Search Results for <span></span></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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.Logging.Printers.GZFilePrinter">
  75. <h1 id="IPA_Logging_Printers_GZFilePrinter" data-uid="IPA.Logging.Printers.GZFilePrinter" class="text-break">Class GZFilePrinter
  76. </h1>
  77. <div class="markdown level0 summary"><p>A <a class="xref" href="IPA.Logging.LogPrinter.html">LogPrinter</a> abstract class that provides the utilities to write to a GZip file.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">Object</a></div>
  83. <div class="level1"><a class="xref" href="IPA.Logging.LogPrinter.html">LogPrinter</a></div>
  84. <div class="level2"><span class="xref">GZFilePrinter</span></div>
  85. <div class="level3"><a class="xref" href="IPA.Logging.Printers.GlobalLogFilePrinter.html">GlobalLogFilePrinter</a></div>
  86. <div class="level3"><a class="xref" href="IPA.Logging.Printers.PluginLogFilePrinter.html">PluginLogFilePrinter</a></div>
  87. <div class="level3"><a class="xref" href="IPA.Logging.Printers.PluginSubLogPrinter.html">PluginSubLogPrinter</a></div>
  88. </div>
  89. <div class="implements">
  90. <h5>Implements</h5>
  91. <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
  92. </div>
  93. <div class="inheritedMembers">
  94. <h5>Inherited Members</h5>
  95. <div>
  96. <a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Filter">LogPrinter.Filter</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Print_IPA_Logging_Logger_Level_System_DateTime_System_String_System_String_">LogPrinter.Print(Logger.Level, DateTime, String, String)</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
  121. </div>
  122. </div>
  123. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Logging.Printers.html">IPA.Logging.Printers</a></h6>
  124. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  125. <h5 id="IPA_Logging_Printers_GZFilePrinter_syntax">Syntax</h5>
  126. <div class="codewrapper">
  127. <pre><code class="lang-csharp hljs">public abstract class GZFilePrinter : LogPrinter, IDisposable</code></pre>
  128. </div>
  129. <h3 id="fields">Fields
  130. </h3>
  131. <span class="small pull-right mobile-hide">
  132. <span class="divider">|</span>
  133. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_FileWriter.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.GZFilePrinter.FileWriter%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>
  134. </span>
  135. <span class="small pull-right mobile-hide">
  136. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/607ab516a4167c897fc4f07fce11fb60225379a5/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L42">View Source</a>
  137. </span>
  138. <h4 id="IPA_Logging_Printers_GZFilePrinter_FileWriter" data-uid="IPA.Logging.Printers.GZFilePrinter.FileWriter">FileWriter</h4>
  139. <div class="markdown level1 summary"><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.streamwriter">StreamWriter</a> that writes to the GZip file.</p>
  140. </div>
  141. <div class="markdown level1 conceptual"></div>
  142. <h5 class="decalaration">Declaration</h5>
  143. <div class="codewrapper">
  144. <pre><code class="lang-csharp hljs">protected StreamWriter FileWriter</code></pre>
  145. </div>
  146. <h5 class="fieldValue">Field Value</h5>
  147. <table class="table table-bordered table-striped table-condensed">
  148. <thead>
  149. <tr>
  150. <th>Type</th>
  151. <th>Description</th>
  152. </tr>
  153. </thead>
  154. <tbody>
  155. <tr>
  156. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.streamwriter">StreamWriter</a></td>
  157. <td><p>the writer to the underlying filestream</p>
  158. </td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. <h3 id="methods">Methods
  163. </h3>
  164. <span class="small pull-right mobile-hide">
  165. <span class="divider">|</span>
  166. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_Dispose.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.GZFilePrinter.Dispose%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>
  167. </span>
  168. <span class="small pull-right mobile-hide">
  169. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/607ab516a4167c897fc4f07fce11fb60225379a5/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L147">View Source</a>
  170. </span>
  171. <a id="IPA_Logging_Printers_GZFilePrinter_Dispose_" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose*"></a>
  172. <h4 id="IPA_Logging_Printers_GZFilePrinter_Dispose" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose">Dispose()</h4>
  173. <div class="markdown level1 summary"></div>
  174. <div class="markdown level1 conceptual"></div>
  175. <h5 class="decalaration">Declaration</h5>
  176. <div class="codewrapper">
  177. <pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
  178. </div>
  179. <span class="small pull-right mobile-hide">
  180. <span class="divider">|</span>
  181. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_Dispose_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.GZFilePrinter.Dispose(System.Boolean)%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>
  182. </span>
  183. <span class="small pull-right mobile-hide">
  184. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/607ab516a4167c897fc4f07fce11fb60225379a5/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L157">View Source</a>
  185. </span>
  186. <a id="IPA_Logging_Printers_GZFilePrinter_Dispose_" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose*"></a>
  187. <h4 id="IPA_Logging_Printers_GZFilePrinter_Dispose_System_Boolean_" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose(System.Boolean)">Dispose(Boolean)</h4>
  188. <div class="markdown level1 summary"><p>Disposes the file printer.</p>
  189. </div>
  190. <div class="markdown level1 conceptual"></div>
  191. <h5 class="decalaration">Declaration</h5>
  192. <div class="codewrapper">
  193. <pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
  194. </div>
  195. <h5 class="parameters">Parameters</h5>
  196. <table class="table table-bordered table-striped table-condensed">
  197. <thead>
  198. <tr>
  199. <th>Type</th>
  200. <th>Name</th>
  201. <th>Description</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  207. <td><span class="parametername">disposing</span></td>
  208. <td><p>does nothing</p>
  209. </td>
  210. </tr>
  211. </tbody>
  212. </table>
  213. <span class="small pull-right mobile-hide">
  214. <span class="divider">|</span>
  215. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_EndPrint.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.GZFilePrinter.EndPrint%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>
  216. </span>
  217. <span class="small pull-right mobile-hide">
  218. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/607ab516a4167c897fc4f07fce11fb60225379a5/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L136">View Source</a>
  219. </span>
  220. <a id="IPA_Logging_Printers_GZFilePrinter_EndPrint_" data-uid="IPA.Logging.Printers.GZFilePrinter.EndPrint*"></a>
  221. <h4 id="IPA_Logging_Printers_GZFilePrinter_EndPrint" data-uid="IPA.Logging.Printers.GZFilePrinter.EndPrint">EndPrint()</h4>
  222. <div class="markdown level1 summary"><p>Called at the end of any print session.</p>
  223. </div>
  224. <div class="markdown level1 conceptual"></div>
  225. <h5 class="decalaration">Declaration</h5>
  226. <div class="codewrapper">
  227. <pre><code class="lang-csharp hljs">public sealed override void EndPrint()</code></pre>
  228. </div>
  229. <h5 class="overrides">Overrides</h5>
  230. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_EndPrint">LogPrinter.EndPrint()</a></div>
  231. <span class="small pull-right mobile-hide">
  232. <span class="divider">|</span>
  233. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_GetFileInfo.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.GZFilePrinter.GetFileInfo%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>
  234. </span>
  235. <span class="small pull-right mobile-hide">
  236. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/607ab516a4167c897fc4f07fce11fb60225379a5/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L50">View Source</a>
  237. </span>
  238. <a id="IPA_Logging_Printers_GZFilePrinter_GetFileInfo_" data-uid="IPA.Logging.Printers.GZFilePrinter.GetFileInfo*"></a>
  239. <h4 id="IPA_Logging_Printers_GZFilePrinter_GetFileInfo" data-uid="IPA.Logging.Printers.GZFilePrinter.GetFileInfo">GetFileInfo()</h4>
  240. <div class="markdown level1 summary"><p>Gets the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a> for the file to write to.</p>
  241. </div>
  242. <div class="markdown level1 conceptual"></div>
  243. <h5 class="decalaration">Declaration</h5>
  244. <div class="codewrapper">
  245. <pre><code class="lang-csharp hljs">protected abstract FileInfo GetFileInfo()</code></pre>
  246. </div>
  247. <h5 class="returns">Returns</h5>
  248. <table class="table table-bordered table-striped table-condensed">
  249. <thead>
  250. <tr>
  251. <th>Type</th>
  252. <th>Description</th>
  253. </tr>
  254. </thead>
  255. <tbody>
  256. <tr>
  257. <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a></td>
  258. <td><p>the file to write to</p>
  259. </td>
  260. </tr>
  261. </tbody>
  262. </table>
  263. <span class="small pull-right mobile-hide">
  264. <span class="divider">|</span>
  265. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_StartPrint.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.GZFilePrinter.StartPrint%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>
  266. </span>
  267. <span class="small pull-right mobile-hide">
  268. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/607ab516a4167c897fc4f07fce11fb60225379a5/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L125">View Source</a>
  269. </span>
  270. <a id="IPA_Logging_Printers_GZFilePrinter_StartPrint_" data-uid="IPA.Logging.Printers.GZFilePrinter.StartPrint*"></a>
  271. <h4 id="IPA_Logging_Printers_GZFilePrinter_StartPrint" data-uid="IPA.Logging.Printers.GZFilePrinter.StartPrint">StartPrint()</h4>
  272. <div class="markdown level1 summary"><p>Called at the start of any print session.</p>
  273. </div>
  274. <div class="markdown level1 conceptual"></div>
  275. <h5 class="decalaration">Declaration</h5>
  276. <div class="codewrapper">
  277. <pre><code class="lang-csharp hljs">public sealed override void StartPrint()</code></pre>
  278. </div>
  279. <h5 class="overrides">Overrides</h5>
  280. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_StartPrint">LogPrinter.StartPrint()</a></div>
  281. <h3 id="implements">Implements</h3>
  282. <div>
  283. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">System.IDisposable</a>
  284. </div>
  285. <h3 id="extensionmethods">Extension Methods</h3>
  286. <div>
  287. <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>
  288. </div>
  289. <div>
  290. <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>
  291. </div>
  292. <div>
  293. <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>
  294. </div>
  295. <div>
  296. <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>
  297. </div>
  298. <div>
  299. <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>
  300. </div>
  301. </article>
  302. </div>
  303. <div class="hidden-sm col-md-2" role="complementary">
  304. <div class="sideaffix">
  305. <div class="contribution">
  306. <ul class="nav">
  307. <li>
  308. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter.md&amp;value=---%0Auid%3A%20IPA.Logging.Printers.GZFilePrinter%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>
  309. </li>
  310. <li>
  311. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/607ab516a4167c897fc4f07fce11fb60225379a5/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L19" class="contribution-link">View Source</a>
  312. </li>
  313. </ul>
  314. </div>
  315. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  316. <h5>In This Article</h5>
  317. <div></div>
  318. </nav>
  319. </div>
  320. </div>
  321. </div>
  322. </div>
  323. <footer>
  324. <div class="grad-bottom"></div>
  325. <div class="footer">
  326. <div class="container">
  327. <span class="pull-right">
  328. <a href="#top">Back to top</a>
  329. </span>
  330. <span>Generated by <strong>DocFX</strong></span>
  331. </div>
  332. </div>
  333. </footer>
  334. </div>
  335. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  336. <script type="text/javascript" src="../styles/docfx.js"></script>
  337. <script type="text/javascript" src="../styles/main.js"></script>
  338. </body>
  339. </html>