| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class DataOutput |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class DataOutput |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="core/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </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="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/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"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </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.Store.DataOutput"> |
| |
| |
| <h1 id="Lucene_Net_Store_DataOutput" data-uid="Lucene.Net.Store.DataOutput" class="text-break">Class DataOutput |
| </h1> |
| <div class="markdown level0 summary"><p>Abstract base class for performing write operations of Lucene's low-level |
| data types.</p> |
| <p><p><a class="xref" href="Lucene.Net.Store.DataOutput.html">DataOutput</a> may only be used from one thread, because it is not |
| thread safe (it keeps internal state like file position).</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">DataOutput</span></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Store.ByteArrayDataOutput.html">ByteArrayDataOutput</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Store.IndexOutput.html">IndexOutput</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Store.OutputStreamDataOutput.html">OutputStreamDataOutput</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Util.GrowableByteArrayDataOutput.html">GrowableByteArrayDataOutput</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Util.PagedBytes.PagedBytesDataOutput.html">PagedBytes.PagedBytesDataOutput</a></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Store.html">Lucene.Net.Store</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Store_DataOutput_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class DataOutput</code></pre> |
| </div> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_CopyBytes_Lucene_Net_Store_DataInput_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.CopyBytes(Lucene.Net.Store.DataInput%2CSystem.Int64)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L263">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_CopyBytes_" data-uid="Lucene.Net.Store.DataOutput.CopyBytes*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_CopyBytes_Lucene_Net_Store_DataInput_System_Int64_" data-uid="Lucene.Net.Store.DataOutput.CopyBytes(Lucene.Net.Store.DataInput,System.Int64)">CopyBytes(DataInput, Int64)</h4> |
| <div class="markdown level1 summary"><p>Copy numBytes bytes from input to ourself. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void CopyBytes(DataInput input, long numBytes)</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="Lucene.Net.Store.DataInput.html">DataInput</a></td> |
| <td><span class="parametername">input</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">numBytes</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_WriteByte_System_Byte_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.WriteByte(System.Byte)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L44">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_WriteByte_" data-uid="Lucene.Net.Store.DataOutput.WriteByte*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_WriteByte_System_Byte_" data-uid="Lucene.Net.Store.DataOutput.WriteByte(System.Byte)">WriteByte(Byte)</h4> |
| <div class="markdown level1 summary"><p>Writes a single byte. |
| <p> |
| The most primitive data type is an eight-bit byte. Files are |
| accessed as sequences of bytes. All other data types are defined |
| as sequences of bytes, so file formats are byte-order independent.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract void WriteByte(byte b)</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><span class="xref">System.Byte</span></td> |
| <td><span class="parametername">b</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataOutput_WriteByte_System_Byte__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadByte">ReadByte</a>()</div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_WriteBytes_System_Byte___System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.WriteBytes(System.Byte%5B%5D%2CSystem.Int32)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L52">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_WriteBytes_" data-uid="Lucene.Net.Store.DataOutput.WriteBytes*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_WriteBytes_System_Byte___System_Int32_" data-uid="Lucene.Net.Store.DataOutput.WriteBytes(System.Byte[],System.Int32)">WriteBytes(Byte[], Int32)</h4> |
| <div class="markdown level1 summary"><p>Writes an array of bytes.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void WriteBytes(byte[] b, int length)</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><span class="xref">System.Byte</span>[]</td> |
| <td><span class="parametername">b</span></td> |
| <td><p>the bytes to write</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">length</span></td> |
| <td><p>the number of bytes to write</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataOutput_WriteBytes_System_Byte___System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadBytes_System_Byte___System_Int32_System_Int32_">ReadBytes</a>(<span class="xref">System.Byte</span>[], <span class="xref">System.Int32</span>, <span class="xref">System.Int32</span>)</div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_WriteBytes_System_Byte___System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.WriteBytes(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L63">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_WriteBytes_" data-uid="Lucene.Net.Store.DataOutput.WriteBytes*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_WriteBytes_System_Byte___System_Int32_System_Int32_" data-uid="Lucene.Net.Store.DataOutput.WriteBytes(System.Byte[],System.Int32,System.Int32)">WriteBytes(Byte[], Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Writes an array of bytes. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract void WriteBytes(byte[] b, int offset, int length)</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><span class="xref">System.Byte</span>[]</td> |
| <td><span class="parametername">b</span></td> |
| <td><p>the bytes to write </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">offset</span></td> |
| <td><p>the offset in the byte array </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">length</span></td> |
| <td><p>the number of bytes to write </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataOutput_WriteBytes_System_Byte___System_Int32_System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadBytes_System_Byte___System_Int32_System_Int32_">ReadBytes</a>(<span class="xref">System.Byte</span>[], <span class="xref">System.Int32</span>, <span class="xref">System.Int32</span>)</div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_WriteInt16_System_Int16_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.WriteInt16(System.Int16)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L87">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_WriteInt16_" data-uid="Lucene.Net.Store.DataOutput.WriteInt16*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_WriteInt16_System_Int16_" data-uid="Lucene.Net.Store.DataOutput.WriteInt16(System.Int16)">WriteInt16(Int16)</h4> |
| <div class="markdown level1 summary"><p>Writes a short as two bytes. |
| <p> |
| NOTE: this was writeShort() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void WriteInt16(short i)</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><span class="xref">System.Int16</span></td> |
| <td><span class="parametername">i</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataOutput_WriteInt16_System_Int16__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadInt16">ReadInt16</a>()</div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_WriteInt32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.WriteInt32(System.Int32)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L73">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_WriteInt32_" data-uid="Lucene.Net.Store.DataOutput.WriteInt32*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_WriteInt32_System_Int32_" data-uid="Lucene.Net.Store.DataOutput.WriteInt32(System.Int32)">WriteInt32(Int32)</h4> |
| <div class="markdown level1 summary"><p>Writes an <span class="xref">System.Int32</span> as four bytes. |
| <p> |
| 32-bit unsigned integer written as four bytes, high-order bytes first. |
| <p> |
| NOTE: this was writeInt() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void WriteInt32(int i)</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><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">i</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataOutput_WriteInt32_System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadInt32">ReadInt32</a>()</div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_WriteInt64_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.WriteInt64(System.Int64)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L216">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_WriteInt64_" data-uid="Lucene.Net.Store.DataOutput.WriteInt64*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_WriteInt64_System_Int64_" data-uid="Lucene.Net.Store.DataOutput.WriteInt64(System.Int64)">WriteInt64(Int64)</h4> |
| <div class="markdown level1 summary"><p>Writes a <span class="xref">System.Int64</span> as eight bytes. |
| <p> |
| 64-bit unsigned integer written as eight bytes, high-order bytes first. |
| <p> |
| NOTE: this was writeLong() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void WriteInt64(long i)</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><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">i</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataOutput_WriteInt64_System_Int64__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadInt64">ReadInt64</a>()</div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_WriteString_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.WriteString(System.String)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L250">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_WriteString_" data-uid="Lucene.Net.Store.DataOutput.WriteString*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_WriteString_System_String_" data-uid="Lucene.Net.Store.DataOutput.WriteString(System.String)">WriteString(String)</h4> |
| <div class="markdown level1 summary"><p>Writes a string. |
| <p> |
| Writes strings as UTF-8 encoded bytes. First the length, in bytes, is |
| written as a <a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteVInt32_System_Int32_">WriteVInt32(Int32)</a>, followed by the bytes.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void WriteString(string s)</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><span class="xref">System.String</span></td> |
| <td><span class="parametername">s</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataOutput_WriteString_System_String__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadString">ReadString</a>()</div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_WriteStringSet_System_Collections_Generic_ISet_System_String__.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.WriteStringSet(System.Collections.Generic.ISet%7BSystem.String%7D)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L321">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_WriteStringSet_" data-uid="Lucene.Net.Store.DataOutput.WriteStringSet*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_WriteStringSet_System_Collections_Generic_ISet_System_String__" data-uid="Lucene.Net.Store.DataOutput.WriteStringSet(System.Collections.Generic.ISet{System.String})">WriteStringSet(ISet<String>)</h4> |
| <div class="markdown level1 summary"><p>Writes a <span class="xref">System.String</span> set. |
| <p> |
| First the size is written as an <a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteInt32_System_Int32_">WriteInt32(Int32)</a>, |
| followed by each value written as a |
| <a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteString_System_String_">WriteString(String)</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void WriteStringSet(ISet<string> set)</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><span class="xref">System.Collections.Generic.ISet</span><<span class="xref">System.String</span>></td> |
| <td><span class="parametername">set</span></td> |
| <td><p>Input <span class="xref">ISet{string}</span>. May be <code>null</code> (equivalent to an empty set) </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_WriteStringStringMap_System_Collections_Generic_IDictionary_System_String_System_String__.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.WriteStringStringMap(System.Collections.Generic.IDictionary%7BSystem.String%2CSystem.String%7D)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L296">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_WriteStringStringMap_" data-uid="Lucene.Net.Store.DataOutput.WriteStringStringMap*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_WriteStringStringMap_System_Collections_Generic_IDictionary_System_String_System_String__" data-uid="Lucene.Net.Store.DataOutput.WriteStringStringMap(System.Collections.Generic.IDictionary{System.String,System.String})">WriteStringStringMap(IDictionary<String, String>)</h4> |
| <div class="markdown level1 summary"><p>Writes a <see cref="T:IDictionary{string, string}"></see>. |
| <p> |
| First the size is written as an <a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteInt32_System_Int32_">WriteInt32(Int32)</a>, |
| followed by each key-value pair written as two consecutive |
| <a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteString_System_String_">WriteString(String)</a>s.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void WriteStringStringMap(IDictionary<string, string> map)</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><span class="xref">System.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.String</span>></td> |
| <td><span class="parametername">map</span></td> |
| <td><p>Input <see cref="T:IDictionary{string, string}"></see>. May be <code>null</code> (equivalent to an empty dictionary) </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_WriteVInt32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.WriteVInt32(System.Int32)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L198">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_WriteVInt32_" data-uid="Lucene.Net.Store.DataOutput.WriteVInt32*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_WriteVInt32_System_Int32_" data-uid="Lucene.Net.Store.DataOutput.WriteVInt32(System.Int32)">WriteVInt32(Int32)</h4> |
| <div class="markdown level1 summary"><p>Writes an <span class="xref">System.Int32</span> in a variable-length format. Writes between one and |
| five bytes. Smaller values take fewer bytes. Negative numbers are |
| supported, but should be avoided. |
| <p>VByte is a variable-length format for positive integers is defined where the |
| high-order bit of each byte indicates whether more bytes remain to be read. The |
| low-order seven bits are appended as increasingly more significant bits in the |
| resulting integer value. Thus values from zero to 127 may be stored in a single |
| byte, values from 128 to 16,383 may be stored in two bytes, and so on.</p> |
| <p>VByte Encoding Example</p> |
| <table><thead><tr><th>ValueByte 1Byte 2Byte 3</th><th></th></tr></thead><tbody><tr><td>000000000</td><td></td></tr><tr><td>100000001</td><td></td></tr><tr><td>200000010</td><td></td></tr><tr><td>...</td><td></td></tr><tr><td>12701111111</td><td></td></tr><tr><td>1281000000000000001</td><td></td></tr><tr><td>1291000000100000001</td><td></td></tr><tr><td>1301000001000000001</td><td></td></tr><tr><td>...</td><td></td></tr><tr><td>16,3831111111101111111</td><td></td></tr><tr><td>16,384100000001000000000000001</td><td></td></tr><tr><td>16,385100000011000000000000001</td><td></td></tr><tr><td>...</td><td></td></tr></tbody></table></p> |
| <p><p>this provides compression while still being efficient to decode.</p> |
| <p> |
| NOTE: this was writeVInt() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void WriteVInt32(int i)</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><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">i</span></td> |
| <td><p>Smaller values take fewer bytes. Negative numbers are |
| supported, but should be avoided. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is an I/O error writing to the underlying medium. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataOutput_WriteVInt32_System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadVInt32">ReadVInt32</a>()</div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput_WriteVInt64_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput.WriteVInt64(System.Int64)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L232">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataOutput_WriteVInt64_" data-uid="Lucene.Net.Store.DataOutput.WriteVInt64*"></a> |
| <h4 id="Lucene_Net_Store_DataOutput_WriteVInt64_System_Int64_" data-uid="Lucene.Net.Store.DataOutput.WriteVInt64(System.Int64)">WriteVInt64(Int64)</h4> |
| <div class="markdown level1 summary"><p>Writes an <span class="xref">System.Int64</span> in a variable-length format. Writes between one and nine |
| bytes. Smaller values take fewer bytes. Negative numbers are not |
| supported. |
| <p> |
| The format is described further in <a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteVInt32_System_Int32_">WriteVInt32(Int32)</a>. |
| <p> |
| NOTE: this was writeVLong() in Lucene</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void WriteVInt64(long i)</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><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">i</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataOutput_WriteVInt64_System_Int64__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadVInt64">ReadVInt64</a>()</div> |
| </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/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataOutput.md&value=---%0Auid%3A%20Lucene.Net.Store.DataOutput%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/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Store/DataOutput.cs/#L34" 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> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
