blob: 063c3c8e409298a8ca8ecdf31e5754961699bd0b [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Namespace Lucene.Net.Support.IO
| Apache Lucene.NET 4.8.0 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Lucene.Net.Support.IO
| Apache Lucene.NET 4.8.0 Documentation ">
<meta name="generator" content="docfx 2.47.0.0">
<link rel="shortcut icon" href="../../logo/favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">
<meta property="docfx:rel" content="../../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar 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/lucene-net-color.png" 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="Lucene.Net.Support.IO">
<h1 id="Lucene_Net_Support_IO" data-uid="Lucene.Net.Support.IO" class="text-break">Namespace Lucene.Net.Support.IO
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Lucene.Net.Support.IO.BinaryReaderDataInput.html">BinaryReaderDataInput</a></h4>
<section></section>
<h4><a class="xref" href="Lucene.Net.Support.IO.BinaryWriterDataOutput.html">BinaryWriterDataOutput</a></h4>
<section></section>
<h4><a class="xref" href="Lucene.Net.Support.IO.ByteArrayOutputStream.html">ByteArrayOutputStream</a></h4>
<section></section>
<h4><a class="xref" href="Lucene.Net.Support.IO.FileStreamExtensions.html">FileStreamExtensions</a></h4>
<section></section>
<h4><a class="xref" href="Lucene.Net.Support.IO.FileSupport.html">FileSupport</a></h4>
<section><p>Represents the methods to support some operations over files.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Support.IO.SafeTextWriterWrapper.html">SafeTextWriterWrapper</a></h4>
<section><p>Decorates a <span class="xref">System.IO.TextWriter</span> instance and
makes no assumptions about whether <span class="xref">System.IDisposable.Dispose()</span>
has been called on the inner instance or not. Acts like a circuit breaker -
the first <span class="xref">System.ObjectDisposedException</span> caught turns it off and
the rest of the calls are ignored after that point until <a class="xref" href="Lucene.Net.Support.IO.SafeTextWriterWrapper.html#Lucene_Net_Support_IO_SafeTextWriterWrapper_Reset">Reset()</a>
is called.
<p>
The primary purpose is for using a <span class="xref">System.IO.TextWriter</span> instance within a non-disposable
parent object. Since the creator of the <span class="xref">System.IO.TextWriter</span> ultimately is responsible for
disposing it, our non-disposable object has no way of knowing whether it is safe to use the <span class="xref">System.IO.TextWriter</span>.
Wraping the <span class="xref">System.IO.TextWriter</span> within a <a class="xref" href="Lucene.Net.Support.IO.SafeTextWriterWrapper.html">SafeTextWriterWrapper</a> ensures the
non-disposable object can continue to make calls to the <span class="xref">System.IO.TextWriter</span> without raising
exceptions (it is presumed that the <span class="xref">System.IO.TextWriter</span> functionality is optional).</p>
</section>
<h4><a class="xref" href="Lucene.Net.Support.IO.StreamExtensions.html">StreamExtensions</a></h4>
<section><p>Extension methods that make a <span class="xref">System.IO.Stream</span> effectively into a
binary serializer with no encoding. We simply convert types into bytes
and write them without any concern whether surrogate pairs are respected,
similar to what BinaryFormatter does.
This makes it possible to serialize/deserialize raw character arrays
and get the data back in the same order without any exceptions warning
that the order is not valid and without the need for BinaryFormatter.
<p>
Byte order is little-endian (same as <span class="xref">System.IO.BinaryReader</span> and <span class="xref">System.IO.BinaryWriter</span>).</p>
</section>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</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>
Copyright © 2020 Licensed to the Apache Software Foundation (ASF)
</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>