Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class ByteArrayDataInput

    DataInput backed by a byte array. WARNING: this class omits all low-level checks.

    Note

    This API is experimental and might change in incompatible ways in the next release.

    Inheritance
    System.Object
    DataInput
    ByteArrayDataInput
    Inherited Members
    DataInput.ReadBytes(Byte[], Int32, Int32, Boolean)
    DataInput.ReadString()
    DataInput.Clone()
    DataInput.ReadStringStringMap()
    DataInput.ReadStringSet()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Lucene.Net.Store
    Assembly: Lucene.Net.dll
    Syntax
    public sealed class ByteArrayDataInput : DataInput

    Constructors

    | Improve this Doc View Source

    ByteArrayDataInput()

    Declaration
    public ByteArrayDataInput()
    | Improve this Doc View Source

    ByteArrayDataInput(Byte[])

    Declaration
    public ByteArrayDataInput(byte[] bytes)
    Parameters
    Type Name Description
    System.Byte[] bytes
    | Improve this Doc View Source

    ByteArrayDataInput(Byte[], Int32, Int32)

    Declaration
    public ByteArrayDataInput(byte[] bytes, int offset, int len)
    Parameters
    Type Name Description
    System.Byte[] bytes
    System.Int32 offset
    System.Int32 len

    Properties

    | Improve this Doc View Source

    Eof

    Declaration
    public bool Eof { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Length

    Declaration
    public int Length { get; }
    Property Value
    Type Description
    System.Int32
    | Improve this Doc View Source

    Position

    Declaration
    public int Position { get; set; }
    Property Value
    Type Description
    System.Int32

    Methods

    | Improve this Doc View Source

    ReadByte()

    Declaration
    public override byte ReadByte()
    Returns
    Type Description
    System.Byte
    Overrides
    DataInput.ReadByte()
    | Improve this Doc View Source

    ReadBytes(Byte[], Int32, Int32)

    Declaration
    public override void ReadBytes(byte[] b, int offset, int len)
    Parameters
    Type Name Description
    System.Byte[] b
    System.Int32 offset
    System.Int32 len
    Overrides
    DataInput.ReadBytes(Byte[], Int32, Int32)
    | Improve this Doc View Source

    ReadInt16()

    LUCENENET NOTE: Important - always cast to ushort (System.UInt16) before using to ensure the value is positive!

    NOTE: this was readShort() in Lucene

    Declaration
    public override short ReadInt16()
    Returns
    Type Description
    System.Int16
    Overrides
    DataInput.ReadInt16()
    | Improve this Doc View Source

    ReadInt32()

    NOTE: this was readInt() in Lucene

    Declaration
    public override int ReadInt32()
    Returns
    Type Description
    System.Int32
    Overrides
    DataInput.ReadInt32()
    | Improve this Doc View Source

    ReadInt64()

    NOTE: this was readLong() in Lucene

    Declaration
    public override long ReadInt64()
    Returns
    Type Description
    System.Int64
    Overrides
    DataInput.ReadInt64()
    | Improve this Doc View Source

    ReadVInt32()

    NOTE: this was readVInt() in Lucene

    Declaration
    public override int ReadVInt32()
    Returns
    Type Description
    System.Int32
    Overrides
    DataInput.ReadVInt32()
    | Improve this Doc View Source

    ReadVInt64()

    NOTE: this was readVLong() in Lucene

    Declaration
    public override long ReadVInt64()
    Returns
    Type Description
    System.Int64
    Overrides
    DataInput.ReadVInt64()
    | Improve this Doc View Source

    Reset(Byte[])

    Declaration
    public void Reset(byte[] bytes)
    Parameters
    Type Name Description
    System.Byte[] bytes
    | Improve this Doc View Source

    Reset(Byte[], Int32, Int32)

    Declaration
    public void Reset(byte[] bytes, int offset, int len)
    Parameters
    Type Name Description
    System.Byte[] bytes
    System.Int32 offset
    System.Int32 len
    | Improve this Doc View Source

    Rewind()

    NOTE: sets pos to 0, which is not right if you had called reset w/ non-zero offset!!

    Declaration
    public void Rewind()
    | Improve this Doc View Source

    SkipBytes(Int64)

    Declaration
    public override void SkipBytes(long count)
    Parameters
    Type Name Description
    System.Int64 count
    Overrides
    DataInput.SkipBytes(Int64)
    • Improve this Doc
    • View Source
    Back to top Copyright © 2022 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.