Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class NIOFSDirectory.NIOFSIndexInput

    Reads bytes with the Read(Stream, ByteBuffer, long) extension method for Stream.

    Inheritance
    object
    DataInput
    IndexInput
    BufferedIndexInput
    NIOFSDirectory.NIOFSIndexInput
    Implements
    IDisposable
    Inherited Members
    BufferedIndexInput.BUFFER_SIZE
    BufferedIndexInput.MERGE_BUFFER_SIZE
    BufferedIndexInput.m_buffer
    BufferedIndexInput.ReadByte()
    BufferedIndexInput.SetBufferSize(int)
    BufferedIndexInput.BufferSize
    BufferedIndexInput.ReadBytes(byte[], int, int)
    BufferedIndexInput.ReadBytes(byte[], int, int, bool)
    BufferedIndexInput.ReadInt16()
    BufferedIndexInput.ReadInt32()
    BufferedIndexInput.ReadInt64()
    BufferedIndexInput.ReadVInt32()
    BufferedIndexInput.ReadVInt64()
    BufferedIndexInput.Position
    BufferedIndexInput.Seek(long)
    BufferedIndexInput.FlushBuffer(IndexOutput, long)
    BufferedIndexInput.GetBufferSize(IOContext)
    IndexInput.Dispose()
    IndexInput.ToString()
    DataInput.ReadString()
    DataInput.ReadStringStringMap()
    DataInput.ReadStringSet()
    DataInput.SkipBytes(long)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Store
    Assembly: Lucene.Net.dll
    Syntax
    protected class NIOFSDirectory.NIOFSIndexInput : BufferedIndexInput, IDisposable

    Constructors

    NIOFSIndexInput(string, FileStream, IOContext)

    Reads bytes with the Read(Stream, ByteBuffer, long) extension method for Stream.

    Declaration
    public NIOFSIndexInput(string resourceDesc, FileStream fc, IOContext context)
    Parameters
    Type Name Description
    string resourceDesc
    FileStream fc
    IOContext context

    NIOFSIndexInput(string, FileStream, long, long, int)

    Reads bytes with the Read(Stream, ByteBuffer, long) extension method for Stream.

    Declaration
    public NIOFSIndexInput(string resourceDesc, FileStream fc, long off, long length, int bufferSize)
    Parameters
    Type Name Description
    string resourceDesc
    FileStream fc
    long off
    long length
    int bufferSize

    Fields

    m_channel

    the file channel we will read from

    Declaration
    protected readonly FileStream m_channel
    Field Value
    Type Description
    FileStream

    m_end

    end offset (start+length)

    Declaration
    protected readonly long m_end
    Field Value
    Type Description
    long

    m_off

    start offset: non-zero in the slice case

    Declaration
    protected readonly long m_off
    Field Value
    Type Description
    long

    Properties

    Length

    The number of bytes in the file.

    Declaration
    public override sealed long Length { get; }
    Property Value
    Type Description
    long
    Overrides
    IndexInput.Length

    Methods

    Clone()

    Returns a clone of this stream.

    Clones of a stream access the same data, and are positioned at the same point as the stream they were cloned from.

    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.

    Warning: Lucene never closes cloned IndexInputs, it will only do this on the original one. The original instance must take care that cloned instances throw ObjectDisposedException when the original one is closed.
    Declaration
    public override object Clone()
    Returns
    Type Description
    object
    Overrides
    BufferedIndexInput.Clone()

    Dispose(bool)

    Closes the stream to further operations.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing
    Overrides
    IndexInput.Dispose(bool)

    NewBuffer(byte[])

    Reads bytes with the Read(Stream, ByteBuffer, long) extension method for Stream.

    Declaration
    protected override void NewBuffer(byte[] newBuffer)
    Parameters
    Type Name Description
    byte[] newBuffer
    Overrides
    BufferedIndexInput.NewBuffer(byte[])

    ReadInternal(byte[], int, int)

    Expert: implements buffer refill. Reads bytes from the current position in the input.

    Declaration
    protected override void ReadInternal(byte[] b, int offset, int len)
    Parameters
    Type Name Description
    byte[] b

    the array to read bytes into

    int offset

    the offset in the array to start storing bytes

    int len
    Overrides
    BufferedIndexInput.ReadInternal(byte[], int, int)

    SeekInternal(long)

    Expert: implements seek. Sets current position in this file, where the next ReadInternal(byte[], int, int) will occur.

    Declaration
    protected override void SeekInternal(long pos)
    Parameters
    Type Name Description
    long pos
    Overrides
    BufferedIndexInput.SeekInternal(long)
    See Also
    ReadInternal(byte[], int, int)

    Implements

    IDisposable
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.