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.
352 lines
19 KiB
352 lines
19 KiB
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class GZFilePrinter
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class GZFilePrinter
|
|
">
|
|
<meta name="generator" content="docfx 2.56.2.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<link rel="stylesheet" href="../styles/fix.css">
|
|
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
<meta property="docfx:rel" content="../">
|
|
<meta property="docfx:newtab" content="true">
|
|
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container body-content">
|
|
|
|
<div id="search-results">
|
|
<div class="search-list"></div>
|
|
<div class="sr-items">
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination"></ul>
|
|
</div>
|
|
</div>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="IPA.Logging.Printers.GZFilePrinter">
|
|
|
|
|
|
<h1 id="IPA_Logging_Printers_GZFilePrinter" data-uid="IPA.Logging.Printers.GZFilePrinter" class="text-break">Class GZFilePrinter
|
|
</h1>
|
|
<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>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
|
|
<div class="level1"><a class="xref" href="IPA.Logging.LogPrinter.html">LogPrinter</a></div>
|
|
<div class="level2"><span class="xref">GZFilePrinter</span></div>
|
|
<div class="level3"><a class="xref" href="IPA.Logging.Printers.GlobalLogFilePrinter.html">GlobalLogFilePrinter</a></div>
|
|
<div class="level3"><a class="xref" href="IPA.Logging.Printers.PluginLogFilePrinter.html">PluginLogFilePrinter</a></div>
|
|
<div class="level3"><a class="xref" href="IPA.Logging.Printers.PluginSubLogPrinter.html">PluginSubLogPrinter</a></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_Filter">LogPrinter.Filter</a>
|
|
</div>
|
|
<div>
|
|
<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>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
|
|
</div>
|
|
<div>
|
|
<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>
|
|
</div>
|
|
<div>
|
|
<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>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="IPA.Logging.Printers.html">IPA.Logging.Printers</a></h6>
|
|
<h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
|
|
<h5 id="IPA_Logging_Printers_GZFilePrinter_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public abstract class GZFilePrinter : LogPrinter, IDisposable</code></pre>
|
|
</div>
|
|
<h3 id="fields">Fields
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_FileWriter.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/20438d3069973fb30153a7db98fe3bbe1b682c84/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L40">View Source</a>
|
|
</span>
|
|
<h4 id="IPA_Logging_Printers_GZFilePrinter_FileWriter" data-uid="IPA.Logging.Printers.GZFilePrinter.FileWriter">FileWriter</h4>
|
|
<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>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected StreamWriter FileWriter</code></pre>
|
|
</div>
|
|
<h5 class="fieldValue">Field Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.streamwriter">StreamWriter</a></td>
|
|
<td><p>the writer to the underlying filestream</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_Dispose.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/20438d3069973fb30153a7db98fe3bbe1b682c84/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L135">View Source</a>
|
|
</span>
|
|
<a id="IPA_Logging_Printers_GZFilePrinter_Dispose_" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose*"></a>
|
|
<h4 id="IPA_Logging_Printers_GZFilePrinter_Dispose" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose">Dispose()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_Dispose_System_Boolean_.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/20438d3069973fb30153a7db98fe3bbe1b682c84/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L145">View Source</a>
|
|
</span>
|
|
<a id="IPA_Logging_Printers_GZFilePrinter_Dispose_" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose*"></a>
|
|
<h4 id="IPA_Logging_Printers_GZFilePrinter_Dispose_System_Boolean_" data-uid="IPA.Logging.Printers.GZFilePrinter.Dispose(System.Boolean)">Dispose(Boolean)</h4>
|
|
<div class="markdown level1 summary"><p>Disposes the file printer.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td><span class="parametername">disposing</span></td>
|
|
<td><p>does nothing</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_EndPrint.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/20438d3069973fb30153a7db98fe3bbe1b682c84/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L124">View Source</a>
|
|
</span>
|
|
<a id="IPA_Logging_Printers_GZFilePrinter_EndPrint_" data-uid="IPA.Logging.Printers.GZFilePrinter.EndPrint*"></a>
|
|
<h4 id="IPA_Logging_Printers_GZFilePrinter_EndPrint" data-uid="IPA.Logging.Printers.GZFilePrinter.EndPrint">EndPrint()</h4>
|
|
<div class="markdown level1 summary"><p>Called at the end of any print session.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override sealed void EndPrint()</code></pre>
|
|
</div>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_EndPrint">LogPrinter.EndPrint()</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_GetFileInfo.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/20438d3069973fb30153a7db98fe3bbe1b682c84/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L48">View Source</a>
|
|
</span>
|
|
<a id="IPA_Logging_Printers_GZFilePrinter_GetFileInfo_" data-uid="IPA.Logging.Printers.GZFilePrinter.GetFileInfo*"></a>
|
|
<h4 id="IPA_Logging_Printers_GZFilePrinter_GetFileInfo" data-uid="IPA.Logging.Printers.GZFilePrinter.GetFileInfo">GetFileInfo()</h4>
|
|
<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>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected abstract FileInfo GetFileInfo()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.io.fileinfo">FileInfo</a></td>
|
|
<td><p>the file to write to</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter_StartPrint.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/20438d3069973fb30153a7db98fe3bbe1b682c84/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L113">View Source</a>
|
|
</span>
|
|
<a id="IPA_Logging_Printers_GZFilePrinter_StartPrint_" data-uid="IPA.Logging.Printers.GZFilePrinter.StartPrint*"></a>
|
|
<h4 id="IPA_Logging_Printers_GZFilePrinter_StartPrint" data-uid="IPA.Logging.Printers.GZFilePrinter.StartPrint">StartPrint()</h4>
|
|
<div class="markdown level1 summary"><p>Called at the start of any print session.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override sealed void StartPrint()</code></pre>
|
|
</div>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="IPA.Logging.LogPrinter.html#IPA_Logging_LogPrinter_StartPrint">LogPrinter.StartPrint()</a></div>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">System.IDisposable</a>
|
|
</div>
|
|
<h3 id="extensionmethods">Extension Methods</h3>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField<T, U>(T, String, U)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField<U, T>(T, String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty<T, U>(T, String, U)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty<U, T>(T, String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod<U, T>(T, String, Object[])</a>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Logging_Printers_GZFilePrinter.md&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>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/20438d3069973fb30153a7db98fe3bbe1b682c84/IPA.Loader/Logging/Printers/GZFilePrinter.cs/#L17" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|