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.

351 lines
19 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>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.43.3.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 href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../">
  21. <meta property="docfx:newtab" content="true">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../index.html">
  35. <img id="logo" class="svg" src="../logo.svg" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list"></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="IPA.Logging.Printers.GZFilePrinter">
  74. <h1 id="IPA_Logging_Printers_GZFilePrinter" data-uid="IPA.Logging.Printers.GZFilePrinter" class="text-break">Class GZFilePrinter
  75. </h1>
  76. <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>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  82. <div class="level1"><a class="xref" href="IPA.Logging.LogPrinter.html">LogPrinter</a></div>
  83. <div class="level2"><span class="xref">GZFilePrinter</span></div>
  84. <div class="level3"><a class="xref" href="IPA.Logging.Printers.GlobalLogFilePrinter.html">GlobalLogFilePrinter</a></div>
  85. <div class="level3"><a class="xref" href="IPA.Logging.Printers.PluginLogFilePrinter.html">PluginLogFilePrinter</a></div>
  86. <div class="level3"><a class="xref" href="IPA.Logging.Printers.PluginSubLogPrinter.html">PluginSubLogPrinter</a></div>
  87. </div>
  88. <div classs="implements">
  89. <h5>Implements</h5>
  90. <div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
  91. </div>
  92. <div class="inheritedMembers">
  93. <h5>Inherited Members</h5>
  94. <div>
  95. <a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Filter">LogPrinter.Filter</a>
  96. </div>
  97. <div>
  98. <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>
  99. </div>
  100. <div>
  101. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  105. </div>
  106. <div>
  107. <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>
  108. </div>
  109. <div>
  110. <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>
  111. </div>
  112. <div>
  113. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  120. </div>
  121. </div>
  122. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Logging.Printers.html">IPA.Logging.Printers</a></h6>
  123. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  124. <h5 id="IPA_Logging_Printers_GZFilePrinter_syntax">Syntax</h5>
  125. <div class="codewrapper">
  126. <pre><code class="lang-csharp hljs">public abstract class GZFilePrinter : LogPrinter, IDisposable</code></pre>
  127. </div>
  128. <h3 id="fields">Fields
  129. </h3>
  130. <span class="small pull-right mobile-hide">
  131. <span class="divider">|</span>
  132. <a href="https://github.com/beat-saber-modding-group/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>
  133. </span>
  134. <span class="small pull-right mobile-hide">
  135. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ecf9dee5cf4f7fc2ab3f39233c8974347004a11e/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L30">View Source</a>
  136. </span>
  137. <h4 id="IPA_Logging_Printers_GZFilePrinter_FileWriter" data-uid="IPA.Logging.Printers.GZFilePrinter.FileWriter">FileWriter</h4>
  138. <div class="markdown level1 summary"><p>The <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.streamwriter">StreamWriter</a> that writes to the GZip file.</p>
  139. </div>
  140. <div class="markdown level1 conceptual"></div>
  141. <h5 class="decalaration">Declaration</h5>
  142. <div class="codewrapper">
  143. <pre><code class="lang-csharp hljs">protected StreamWriter FileWriter</code></pre>
  144. </div>
  145. <h5 class="fieldValue">Field Value</h5>
  146. <table class="table table-bordered table-striped table-condensed">
  147. <thead>
  148. <tr>
  149. <th>Type</th>
  150. <th>Description</th>
  151. </tr>
  152. </thead>
  153. <tbody>
  154. <tr>
  155. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.streamwriter">StreamWriter</a></td>
  156. <td><p>the writer to the underlying filestream</p>
  157. </td>
  158. </tr>
  159. </tbody>
  160. </table>
  161. <h3 id="methods">Methods
  162. </h3>
  163. <span class="small pull-right mobile-hide">
  164. <span class="divider">|</span>
  165. <a href="https://github.com/beat-saber-modding-group/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>
  166. </span>
  167. <span class="small pull-right mobile-hide">
  168. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ecf9dee5cf4f7fc2ab3f39233c8974347004a11e/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L125">View Source</a>
  169. </span>
  170. <a id="IPA_Logging_Printers_GZFilePrinter_Dispose_" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose*"></a>
  171. <h4 id="IPA_Logging_Printers_GZFilePrinter_Dispose" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose">Dispose()</h4>
  172. <div class="markdown level1 summary"></div>
  173. <div class="markdown level1 conceptual"></div>
  174. <h5 class="decalaration">Declaration</h5>
  175. <div class="codewrapper">
  176. <pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
  177. </div>
  178. <span class="small pull-right mobile-hide">
  179. <span class="divider">|</span>
  180. <a href="https://github.com/beat-saber-modding-group/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>
  181. </span>
  182. <span class="small pull-right mobile-hide">
  183. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ecf9dee5cf4f7fc2ab3f39233c8974347004a11e/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L135">View Source</a>
  184. </span>
  185. <a id="IPA_Logging_Printers_GZFilePrinter_Dispose_" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose*"></a>
  186. <h4 id="IPA_Logging_Printers_GZFilePrinter_Dispose_System_Boolean_" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose(System.Boolean)">Dispose(Boolean)</h4>
  187. <div class="markdown level1 summary"><p>Disposes the file printer.</p>
  188. </div>
  189. <div class="markdown level1 conceptual"></div>
  190. <h5 class="decalaration">Declaration</h5>
  191. <div class="codewrapper">
  192. <pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
  193. </div>
  194. <h5 class="parameters">Parameters</h5>
  195. <table class="table table-bordered table-striped table-condensed">
  196. <thead>
  197. <tr>
  198. <th>Type</th>
  199. <th>Name</th>
  200. <th>Description</th>
  201. </tr>
  202. </thead>
  203. <tbody>
  204. <tr>
  205. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  206. <td><span class="parametername">disposing</span></td>
  207. <td><p>does nothing</p>
  208. </td>
  209. </tr>
  210. </tbody>
  211. </table>
  212. <span class="small pull-right mobile-hide">
  213. <span class="divider">|</span>
  214. <a href="https://github.com/beat-saber-modding-group/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>
  215. </span>
  216. <span class="small pull-right mobile-hide">
  217. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ecf9dee5cf4f7fc2ab3f39233c8974347004a11e/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L114">View Source</a>
  218. </span>
  219. <a id="IPA_Logging_Printers_GZFilePrinter_EndPrint_" data-uid="IPA.Logging.Printers.GZFilePrinter.EndPrint*"></a>
  220. <h4 id="IPA_Logging_Printers_GZFilePrinter_EndPrint" data-uid="IPA.Logging.Printers.GZFilePrinter.EndPrint">EndPrint()</h4>
  221. <div class="markdown level1 summary"><p>Called at the end of any print session.</p>
  222. </div>
  223. <div class="markdown level1 conceptual"></div>
  224. <h5 class="decalaration">Declaration</h5>
  225. <div class="codewrapper">
  226. <pre><code class="lang-csharp hljs">public override sealed void EndPrint()</code></pre>
  227. </div>
  228. <h5 class="overrides">Overrides</h5>
  229. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_EndPrint">LogPrinter.EndPrint()</a></div>
  230. <span class="small pull-right mobile-hide">
  231. <span class="divider">|</span>
  232. <a href="https://github.com/beat-saber-modding-group/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>
  233. </span>
  234. <span class="small pull-right mobile-hide">
  235. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ecf9dee5cf4f7fc2ab3f39233c8974347004a11e/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L38">View Source</a>
  236. </span>
  237. <a id="IPA_Logging_Printers_GZFilePrinter_GetFileInfo_" data-uid="IPA.Logging.Printers.GZFilePrinter.GetFileInfo*"></a>
  238. <h4 id="IPA_Logging_Printers_GZFilePrinter_GetFileInfo" data-uid="IPA.Logging.Printers.GZFilePrinter.GetFileInfo">GetFileInfo()</h4>
  239. <div class="markdown level1 summary"><p>Gets the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a> for the file to write to.</p>
  240. </div>
  241. <div class="markdown level1 conceptual"></div>
  242. <h5 class="decalaration">Declaration</h5>
  243. <div class="codewrapper">
  244. <pre><code class="lang-csharp hljs">protected abstract FileInfo GetFileInfo()</code></pre>
  245. </div>
  246. <h5 class="returns">Returns</h5>
  247. <table class="table table-bordered table-striped table-condensed">
  248. <thead>
  249. <tr>
  250. <th>Type</th>
  251. <th>Description</th>
  252. </tr>
  253. </thead>
  254. <tbody>
  255. <tr>
  256. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a></td>
  257. <td><p>the file to write to</p>
  258. </td>
  259. </tr>
  260. </tbody>
  261. </table>
  262. <span class="small pull-right mobile-hide">
  263. <span class="divider">|</span>
  264. <a href="https://github.com/beat-saber-modding-group/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>
  265. </span>
  266. <span class="small pull-right mobile-hide">
  267. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ecf9dee5cf4f7fc2ab3f39233c8974347004a11e/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L103">View Source</a>
  268. </span>
  269. <a id="IPA_Logging_Printers_GZFilePrinter_StartPrint_" data-uid="IPA.Logging.Printers.GZFilePrinter.StartPrint*"></a>
  270. <h4 id="IPA_Logging_Printers_GZFilePrinter_StartPrint" data-uid="IPA.Logging.Printers.GZFilePrinter.StartPrint">StartPrint()</h4>
  271. <div class="markdown level1 summary"><p>Called at the start of any print session.</p>
  272. </div>
  273. <div class="markdown level1 conceptual"></div>
  274. <h5 class="decalaration">Declaration</h5>
  275. <div class="codewrapper">
  276. <pre><code class="lang-csharp hljs">public override sealed void StartPrint()</code></pre>
  277. </div>
  278. <h5 class="overrides">Overrides</h5>
  279. <div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_StartPrint">LogPrinter.StartPrint()</a></div>
  280. <h3 id="implements">Implements</h3>
  281. <div>
  282. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">System.IDisposable</a>
  283. </div>
  284. <h3 id="extensionmethods">Extension Methods</h3>
  285. <div>
  286. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateField_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateField(Object, String, Object)</a>
  287. </div>
  288. <div>
  289. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetPrivateField__1_System_Object_System_String_">ReflectionUtil.GetPrivateField&lt;T&gt;(Object, String)</a>
  290. </div>
  291. <div>
  292. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetPrivateProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetPrivateProperty(Object, String, Object)</a>
  293. </div>
  294. <div>
  295. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod(Object, String, Object[])</a>
  296. </div>
  297. <div>
  298. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokePrivateMethod__1_System_Object_System_String_System_Object___">ReflectionUtil.InvokePrivateMethod&lt;T&gt;(Object, String, Object[])</a>
  299. </div>
  300. </article>
  301. </div>
  302. <div class="hidden-sm col-md-2" role="complementary">
  303. <div class="sideaffix">
  304. <div class="contribution">
  305. <ul class="nav">
  306. <li>
  307. <a href="https://github.com/beat-saber-modding-group/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>
  308. </li>
  309. <li>
  310. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/ecf9dee5cf4f7fc2ab3f39233c8974347004a11e/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L13" class="contribution-link">View Source</a>
  311. </li>
  312. </ul>
  313. </div>
  314. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  315. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  316. </nav>
  317. </div>
  318. </div>
  319. </div>
  320. </div>
  321. <footer>
  322. <div class="grad-bottom"></div>
  323. <div class="footer">
  324. <div class="container">
  325. <span class="pull-right">
  326. <a href="#top">Back to top</a>
  327. </span>
  328. <span>Generated by <strong>DocFX</strong></span>
  329. </div>
  330. </div>
  331. </footer>
  332. </div>
  333. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  334. <script type="text/javascript" src="../styles/docfx.js"></script>
  335. <script type="text/javascript" src="../styles/main.js"></script>
  336. </body>
  337. </html>