Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class RAMInputStream

    A memory-resident IndexInput implementation.

    Note

    This API is for internal purposes only and might change in incompatible ways in the next release.

    Inheritance
    object
    DataInput
    IndexInput
    RAMInputStream
    Implements
    IDisposable
    Inherited Members
    IndexInput.Dispose()
    IndexInput.ToString()
    IndexInput.Clone()
    DataInput.ReadBytes(byte[], int, int, bool)
    DataInput.ReadInt16()
    DataInput.ReadInt32()
    DataInput.ReadVInt32()
    DataInput.ReadInt64()
    DataInput.ReadVInt64()
    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
    public class RAMInputStream : IndexInput, IDisposable

    Constructors

    RAMInputStream(string, RAMFile)

    A memory-resident IndexInput implementation.

    Note

    This API is for internal purposes only and might change in incompatible ways in the next release.

    Declaration
    public RAMInputStream(string name, RAMFile f)
    Parameters
    Type Name Description
    string name
    RAMFile f

    Properties

    Length

    The number of bytes in the file.

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

    Position

    Returns the current position in this file, where the next read will occur.

    This was getFilePointer() in Lucene.
    Declaration
    public override long Position { get; }
    Property Value
    Type Description
    long
    Overrides
    IndexInput.Position
    See Also
    Seek(long)

    Methods

    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)

    ReadByte()

    Reads and returns a single byte.

    Declaration
    public override byte ReadByte()
    Returns
    Type Description
    byte
    Overrides
    DataInput.ReadByte()
    See Also
    WriteByte(byte)

    ReadBytes(byte[], int, int)

    Reads a specified number of bytes into an array at the specified offset.

    Declaration
    public override void ReadBytes(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

    the number of bytes to read

    Overrides
    DataInput.ReadBytes(byte[], int, int)
    See Also
    WriteBytes(byte[], int)

    Seek(long)

    Sets current position in this file, where the next read will occur.

    Declaration
    public override void Seek(long pos)
    Parameters
    Type Name Description
    long pos
    Overrides
    IndexInput.Seek(long)
    See Also
    Position

    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.