| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class DataInput |
| | Apache Lucene.NET 4.8.0-beta00008 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class DataInput |
| | Apache Lucene.NET 4.8.0-beta00008 Documentation "> |
| <meta name="generator" content="docfx 2.50.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.Store.DataInput"> |
| |
| |
| <h1 id="Lucene_Net_Store_DataInput" data-uid="Lucene.Net.Store.DataInput" class="text-break">Class DataInput |
| </h1> |
| <div class="markdown level0 summary"><p>Abstract base class for performing read operations of Lucene's low-level |
| data types.</p> |
| <p><p><a class="xref" href="Lucene.Net.Store.DataInput.html">DataInput</a> may only be used from one thread, because it is not |
| thread safe (it keeps internal state like file position). To allow |
| multithreaded use, every <a class="xref" href="Lucene.Net.Store.DataInput.html">DataInput</a> instance must be cloned before |
| used in another thread. Subclasses must therefore implement <a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_Clone">Clone()</a>, |
| returning a new <a class="xref" href="Lucene.Net.Store.DataInput.html">DataInput</a> which operates on the same underlying |
| resource, but positioned independently.</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">DataInput</span></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Index.ByteSliceReader.html">ByteSliceReader</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Store.ByteArrayDataInput.html">ByteArrayDataInput</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Store.IndexInput.html">IndexInput</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Store.InputStreamDataInput.html">InputStreamDataInput</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Util.Fst.FST.BytesReader.html">FST.BytesReader</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Util.PagedBytes.PagedBytesDataInput.html">PagedBytes.PagedBytesDataInput</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.TestFramework/Lucene.Net.Store.html">Lucene.Net.Store</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Store_DataInput_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class DataInput</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_Clone.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.Clone%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L272">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_Clone_" data-uid="Lucene.Net.Store.DataInput.Clone*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_Clone" data-uid="Lucene.Net.Store.DataInput.Clone">Clone()</h4> |
| <div class="markdown level1 summary"><p>Returns a clone of this stream.</p> |
| <p><p>Clones of a stream access the same data, and are positioned at the same |
| point as the stream they were cloned from.</p> |
| <p><p>Expert: Subclasses must ensure that clones may be positioned at |
| different points in the input from each other and from the stream they |
| were cloned from.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual object Clone()</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><span class="xref">System.Object</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_ReadByte.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.ReadByte%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L59">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_ReadByte_" data-uid="Lucene.Net.Store.DataInput.ReadByte*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_ReadByte" data-uid="Lucene.Net.Store.DataInput.ReadByte">ReadByte()</h4> |
| <div class="markdown level1 summary"><p>Reads and returns a single byte. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract byte ReadByte()</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><span class="xref">System.Byte</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataInput_ReadByte_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteByte_System_Byte_">WriteByte</a>(<span class="xref">System.Byte</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_ReadBytes_System_Byte___System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.ReadBytes(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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L67">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_ReadBytes_" data-uid="Lucene.Net.Store.DataInput.ReadBytes*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_ReadBytes_System_Byte___System_Int32_System_Int32_" data-uid="Lucene.Net.Store.DataInput.ReadBytes(System.Byte[],System.Int32,System.Int32)">ReadBytes(Byte[], Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Reads a specified number of bytes into an array at the specified offset. </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 ReadBytes(byte[] b, int offset, int len)</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 array to read bytes into </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 array to start storing bytes </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">len</span></td> |
| <td><p>the number of bytes to read </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataInput_ReadBytes_System_Byte___System_Int32_System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteBytes_System_Byte___System_Int32_">WriteBytes</a>(<span class="xref">System.Byte</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_ReadBytes_System_Byte___System_Int32_System_Int32_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.ReadBytes(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32%2CSystem.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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L81">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_ReadBytes_" data-uid="Lucene.Net.Store.DataInput.ReadBytes*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_ReadBytes_System_Byte___System_Int32_System_Int32_System_Boolean_" data-uid="Lucene.Net.Store.DataInput.ReadBytes(System.Byte[],System.Int32,System.Int32,System.Boolean)">ReadBytes(Byte[], Int32, Int32, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Reads a specified number of bytes into an array at the |
| specified offset with control over whether the read |
| should be buffered (callers who have their own buffer |
| should pass in "false" for <code data-dev-comment-type="paramref" class="paramref">useBuffer</code>). Currently only |
| <a class="xref" href="Lucene.Net.Store.BufferedIndexInput.html">BufferedIndexInput</a> respects this parameter. </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 ReadBytes(byte[] b, int offset, int len, bool useBuffer)</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 array to read bytes into </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 array to start storing bytes </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">len</span></td> |
| <td><p>the number of bytes to read </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">useBuffer</span></td> |
| <td><p>set to false if the caller will handle |
| buffering. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataInput_ReadBytes_System_Byte___System_Int32_System_Int32_System_Boolean__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteBytes_System_Byte___System_Int32_">WriteBytes</a>(<span class="xref">System.Byte</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_ReadInt16.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.ReadInt16%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L96">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_ReadInt16_" data-uid="Lucene.Net.Store.DataInput.ReadInt16*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_ReadInt16" data-uid="Lucene.Net.Store.DataInput.ReadInt16">ReadInt16()</h4> |
| <div class="markdown level1 summary"><p>Reads two bytes and returns a <span class="xref">System.Int16</span>. |
| <p> |
| LUCENENET NOTE: Important - always cast to ushort (System.UInt16) before using to ensure |
| the value is positive! |
| <p> |
| NOTE: this was readShort() 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 short ReadInt16()</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><span class="xref">System.Int16</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataInput_ReadInt16_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteInt16_System_Int16_">WriteInt16</a>(<span class="xref">System.Int16</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_ReadInt32.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.ReadInt32%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L107">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_ReadInt32_" data-uid="Lucene.Net.Store.DataInput.ReadInt32*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_ReadInt32" data-uid="Lucene.Net.Store.DataInput.ReadInt32">ReadInt32()</h4> |
| <div class="markdown level1 summary"><p>Reads four bytes and returns an <span class="xref">System.Int32</span>. |
| <p> |
| NOTE: this was readInt() 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 int ReadInt32()</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><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataInput_ReadInt32_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteInt32_System_Int32_">WriteInt32</a>(<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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_ReadInt64.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.ReadInt64%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L165">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_ReadInt64_" data-uid="Lucene.Net.Store.DataInput.ReadInt64*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_ReadInt64" data-uid="Lucene.Net.Store.DataInput.ReadInt64">ReadInt64()</h4> |
| <div class="markdown level1 summary"><p>Reads eight bytes and returns a <span class="xref">System.Int64</span>. |
| <p> |
| NOTE: this was readLong() 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 long ReadInt64()</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><span class="xref">System.Int64</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataInput_ReadInt64_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteInt64_System_Int64_">WriteInt64</a>(<span class="xref">System.Int64</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_ReadString.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.ReadString%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L253">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_ReadString_" data-uid="Lucene.Net.Store.DataInput.ReadString*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_ReadString" data-uid="Lucene.Net.Store.DataInput.ReadString">ReadString()</h4> |
| <div class="markdown level1 summary"><p>Reads a <span class="xref">System.String</span>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string ReadString()</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><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataInput_ReadString_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteString_System_String_">WriteString</a>(<span class="xref">System.String</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_ReadStringSet.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.ReadStringSet%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L299">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_ReadStringSet_" data-uid="Lucene.Net.Store.DataInput.ReadStringSet*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_ReadStringSet" data-uid="Lucene.Net.Store.DataInput.ReadStringSet">ReadStringSet()</h4> |
| <div class="markdown level1 summary"><p>Reads a ISet<string> previously written |
| with <a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteStringSet_System_Collections_Generic_ISet_System_String__">WriteStringSet(ISet<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 ISet<string> ReadStringSet()</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><span class="xref">System.Collections.Generic.ISet</span><<span class="xref">System.String</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_ReadStringStringMap.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.ReadStringStringMap%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L281">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_ReadStringStringMap_" data-uid="Lucene.Net.Store.DataInput.ReadStringStringMap*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_ReadStringStringMap" data-uid="Lucene.Net.Store.DataInput.ReadStringStringMap">ReadStringStringMap()</h4> |
| <div class="markdown level1 summary"><p>Reads a IDictionary<string,string> previously written |
| with <a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteStringStringMap_System_Collections_Generic_IDictionary_System_String_System_String__">WriteStringStringMap(IDictionary<String, 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 IDictionary<string, string> ReadStringStringMap()</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><span class="xref">System.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.String</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_ReadVInt32.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.ReadVInt32%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L123">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_ReadVInt32_" data-uid="Lucene.Net.Store.DataInput.ReadVInt32*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_ReadVInt32" data-uid="Lucene.Net.Store.DataInput.ReadVInt32">ReadVInt32()</h4> |
| <div class="markdown level1 summary"><p>Reads an <span class="xref">System.Int32</span> stored in variable-length format. Reads between one and |
| five 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 readVInt() 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 int ReadVInt32()</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><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataInput_ReadVInt32_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteVInt32_System_Int32_">WriteVInt32</a>(<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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_ReadVInt64.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.ReadVInt64%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L180">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_ReadVInt64_" data-uid="Lucene.Net.Store.DataInput.ReadVInt64*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_ReadVInt64" data-uid="Lucene.Net.Store.DataInput.ReadVInt64">ReadVInt64()</h4> |
| <div class="markdown level1 summary"><p>Reads a <span class="xref">System.Int64</span> stored in variable-length format. Reads 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 readVLong() 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 long ReadVInt64()</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><span class="xref">System.Int64</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Store_DataInput_ReadVInt64_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteVInt64_System_Int64_">WriteVInt64</a>(<span class="xref">System.Int64</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput_SkipBytes_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput.SkipBytes(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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L317">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_DataInput_SkipBytes_" data-uid="Lucene.Net.Store.DataInput.SkipBytes*"></a> |
| <h4 id="Lucene_Net_Store_DataInput_SkipBytes_System_Int64_" data-uid="Lucene.Net.Store.DataInput.SkipBytes(System.Int64)">SkipBytes(Int64)</h4> |
| <div class="markdown level1 summary"><p>Skip over <code data-dev-comment-type="paramref" class="paramref">numBytes</code> bytes. The contract on this method is that it |
| should have the same behavior as reading the same number of bytes into a |
| buffer and discarding its content. Negative values of <code data-dev-comment-type="paramref" class="paramref">numBytes</code> |
| are not supported.</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 SkipBytes(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><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">numBytes</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| </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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_DataInput.md&value=---%0Auid%3A%20Lucene.Net.Store.DataInput%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net/Store/DataInput.cs/#L38" 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="../../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> |
