Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class BufferedChecksumIndexInput

    Simple implementation of ChecksumIndexInput that wraps another input and delegates calls.

    Inheritance
    object
    DataInput
    IndexInput
    ChecksumIndexInput
    BufferedChecksumIndexInput
    Implements
    IDisposable
    Inherited Members
    ChecksumIndexInput.Seek(long)
    IndexInput.Dispose()
    IndexInput.ToString()
    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 BufferedChecksumIndexInput : ChecksumIndexInput, IDisposable

    Constructors

    BufferedChecksumIndexInput(IndexInput)

    Creates a new BufferedChecksumIndexInput

    Declaration
    public BufferedChecksumIndexInput(IndexInput main)
    Parameters
    Type Name Description
    IndexInput main

    Properties

    Checksum

    Returns the current checksum value

    Declaration
    public override long Checksum { get; }
    Property Value
    Type Description
    long
    Overrides
    ChecksumIndexInput.Checksum

    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

    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
    IndexInput.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)

    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)

    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.