| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class MMapDirectory.MMapIndexInput |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class MMapDirectory.MMapIndexInput |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.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"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <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.MMapDirectory.MMapIndexInput"> |
| |
| |
| <h1 id="Lucene_Net_Store_MMapDirectory_MMapIndexInput" data-uid="Lucene.Net.Store.MMapDirectory.MMapIndexInput" class="text-break">Class MMapDirectory.MMapIndexInput |
| </h1> |
| <div class="markdown level0 summary"></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"><a class="xref" href="Lucene.Net.Store.DataInput.html">DataInput</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Store.IndexInput.html">IndexInput</a></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html">ByteBufferIndexInput</a></div> |
| <div class="level4"><span class="xref">MMapDirectory.MMapIndexInput</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">System.IDisposable</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_ReadByte">ByteBufferIndexInput.ReadByte()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_ReadBytes_System_Byte___System_Int32_System_Int32_">ByteBufferIndexInput.ReadBytes(Byte[], Int32, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_ReadInt16">ByteBufferIndexInput.ReadInt16()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_ReadInt32">ByteBufferIndexInput.ReadInt32()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_ReadInt64">ByteBufferIndexInput.ReadInt64()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_GetFilePointer">ByteBufferIndexInput.GetFilePointer()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_Seek_System_Int64_">ByteBufferIndexInput.Seek(Int64)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_Length">ByteBufferIndexInput.Length</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_Clone">ByteBufferIndexInput.Clone()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_Slice_System_String_System_Int64_System_Int64_">ByteBufferIndexInput.Slice(String, Int64, Int64)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_ToString">ByteBufferIndexInput.ToString()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.IndexInput.html#Lucene_Net_Store_IndexInput_Dispose">IndexInput.Dispose()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadBytes_System_Byte___System_Int32_System_Int32_System_Boolean_">DataInput.ReadBytes(Byte[], Int32, Int32, Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadVInt32">DataInput.ReadVInt32()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadVInt64">DataInput.ReadVInt64()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadString">DataInput.ReadString()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadStringStringMap">DataInput.ReadStringStringMap()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_ReadStringSet">DataInput.ReadStringSet()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.DataInput.html#Lucene_Net_Store_DataInput_SkipBytes_System_Int64_">DataInput.SkipBytes(Int64)</a> |
| </div> |
| <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> |
| <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_MMapDirectory_MMapIndexInput_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class MMapIndexInput : ByteBufferIndexInput, IDisposable</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_MMapDirectory_MMapIndexInput_Dispose_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Store.MMapDirectory.MMapIndexInput.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/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Store/MMapDirectory.cs/#L241">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_MMapDirectory_MMapIndexInput_Dispose_" data-uid="Lucene.Net.Store.MMapDirectory.MMapIndexInput.Dispose*"></a> |
| <h4 id="Lucene_Net_Store_MMapDirectory_MMapIndexInput_Dispose_System_Boolean_" data-uid="Lucene.Net.Store.MMapDirectory.MMapIndexInput.Dispose(System.Boolean)">Dispose(Boolean)</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">protected override sealed 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><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">disposing</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_Dispose_System_Boolean_">ByteBufferIndexInput.Dispose(Boolean)</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_MMapDirectory_MMapIndexInput_FreeBuffer_J2N_IO_ByteBuffer_.md&value=---%0Auid%3A%20Lucene.Net.Store.MMapDirectory.MMapIndexInput.FreeBuffer(J2N.IO.ByteBuffer)%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/fix/apidocs-layout/src/Lucene.Net/Store/MMapDirectory.cs/#L274">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_MMapDirectory_MMapIndexInput_FreeBuffer_" data-uid="Lucene.Net.Store.MMapDirectory.MMapIndexInput.FreeBuffer*"></a> |
| <h4 id="Lucene_Net_Store_MMapDirectory_MMapIndexInput_FreeBuffer_J2N_IO_ByteBuffer_" data-uid="Lucene.Net.Store.MMapDirectory.MMapIndexInput.FreeBuffer(J2N.IO.ByteBuffer)">FreeBuffer(ByteBuffer)</h4> |
| <div class="markdown level1 summary"><p>Try to unmap the buffer, this method silently fails if no support |
| for that in the runtime. On Windows, this leads to the fact, |
| that mmapped files cannot be modified or deleted.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected override void FreeBuffer(ByteBuffer buffer)</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">J2N.IO.ByteBuffer</span></td> |
| <td><span class="parametername">buffer</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Store.ByteBufferIndexInput.html#Lucene_Net_Store_ByteBufferIndexInput_FreeBuffer_J2N_IO_ByteBuffer_">ByteBufferIndexInput.FreeBuffer(ByteBuffer)</a></div> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">System.IDisposable</span> |
| </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_MMapDirectory_MMapIndexInput.md&value=---%0Auid%3A%20Lucene.Net.Store.MMapDirectory.MMapIndexInput%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/fix/apidocs-layout/src/Lucene.Net/Store/MMapDirectory.cs/#L229" 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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </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> |
