Skip to main content

TableIndex.go

TableIndex.go - Overview​

This file defines the TableIndex FlatBuffer object and related helper functions for accessing and manipulating TableIndex data.

Detailed Documentation​

TableIndex​

type TableIndex struct {
	_tab flatbuffers.Table
}
  • Purpose: Represents a TableIndex FlatBuffer table.
  • Members:
    • _tab: A flatbuffers.Table object that holds the underlying FlatBuffer data.

GetRootAsTableIndex​

func GetRootAsTableIndex(buf []byte, offset flatbuffers.UOffsetT) *TableIndex {
	n := flatbuffers.GetUOffsetT(buf[offset:])
	x := &TableIndex{}
	x.Init(buf, n+offset)
	return x
}
  • Purpose: Creates a TableIndex object from a byte buffer at a given offset.
  • Parameters:
    • buf: The byte buffer containing the FlatBuffer data.
    • offset: The offset in the buffer where the TableIndex object starts.
  • Returns: A pointer to the created TableIndex object.

Init​

func (rcv *TableIndex) Init(buf []byte, i flatbuffers.UOffsetT) {
	rcv._tab.Bytes = buf
	rcv._tab.Pos = i
}
  • Purpose: Initializes a TableIndex object with a byte buffer and an offset.
  • Parameters:
    • buf: The byte buffer containing the FlatBuffer data.
    • i: The offset in the buffer where the TableIndex object starts.
  • Returns: None

Table​

func (rcv *TableIndex) Table() flatbuffers.Table {
	return rcv._tab
}
  • Purpose: Returns the underlying flatbuffers.Table object.
  • Parameters: None
  • Returns: The underlying flatbuffers.Table object.

Offsets​

func (rcv *TableIndex) Offsets(obj *BlockOffset, j int) bool {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(4))
	if o != 0 {
		x := rcv._tab.Vector(o)
		x += flatbuffers.UOffsetT(j) * 4
		x = rcv._tab.Indirect(x)
		obj.Init(rcv._tab.Bytes, x)
		return true
	}
	return false
}
  • Purpose: Retrieves the BlockOffset object at a given index in the Offsets vector.
  • Parameters:
    • obj: A pointer to a BlockOffset object to be initialized with the data.
    • j: The index of the BlockOffset object in the vector.
  • Returns: true if the object was successfully retrieved and initialized, false otherwise.

OffsetsLength​

func (rcv *TableIndex) OffsetsLength() int {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(4))
	if o != 0 {
		return rcv._tab.VectorLen(o)
	}
	return 0
}
  • Purpose: Returns the length of the Offsets vector.
  • Parameters: None
  • Returns: The length of the Offsets vector.

BloomFilter​

func (rcv *TableIndex) BloomFilter(j int) byte {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(6))
	if o != 0 {
		a := rcv._tab.Vector(o)
		return rcv._tab.GetByte(a + flatbuffers.UOffsetT(j*1))
	}
	return 0
}
  • Purpose: Returns the byte at a given index in the BloomFilter vector.
  • Parameters:
    • j: The index of the byte in the vector.
  • Returns: The byte at the given index.

BloomFilterLength​

func (rcv *TableIndex) BloomFilterLength() int {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(6))
	if o != 0 {
		return rcv._tab.VectorLen(o)
	}
	return 0
}
  • Purpose: Returns the length of the BloomFilter vector.
  • Parameters: None
  • Returns: The length of the BloomFilter vector.

BloomFilterBytes​

func (rcv *TableIndex) BloomFilterBytes() []byte {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(6))
	if o != 0 {
		return rcv._tab.ByteVector(o + rcv._tab.Pos)
	}
	return nil
}
  • Purpose: Returns the BloomFilter vector as a byte slice.
  • Parameters: None
  • Returns: The BloomFilter vector as a byte slice.

MutateBloomFilter​

func (rcv *TableIndex) MutateBloomFilter(j int, n byte) bool {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(6))
	if o != 0 {
		a := rcv._tab.Vector(o)
		return rcv._tab.MutateByte(a+flatbuffers.UOffsetT(j*1), n)
	}
	return false
}
  • Purpose: Mutates the byte at a given index in the BloomFilter vector.
  • Parameters:
    • j: The index of the byte in the vector.
    • n: The new value for the byte.
  • Returns: true if the mutation was successful, false otherwise.

MaxVersion​

func (rcv *TableIndex) MaxVersion() uint64 {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(8))
	if o != 0 {
		return rcv._tab.GetUint64(o + rcv._tab.Pos)
	}
	return 0
}
  • Purpose: Returns the value of the MaxVersion field.
  • Parameters: None
  • Returns: The value of the MaxVersion field.

MutateMaxVersion​

func (rcv *TableIndex) MutateMaxVersion(n uint64) bool {
	return rcv._tab.MutateUint64Slot(8, n)
}
  • Purpose: Mutates the value of the MaxVersion field.
  • Parameters:
    • n: The new value for the MaxVersion field.
  • Returns: true if the mutation was successful, false otherwise.

KeyCount​

func (rcv *TableIndex) KeyCount() uint32 {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(10))
	if o != 0 {
		return rcv._tab.GetUint32(o + rcv._tab.Pos)
	}
	return 0
}
  • Purpose: Returns the value of the KeyCount field.
  • Parameters: None
  • Returns: The value of the KeyCount field.

MutateKeyCount​

func (rcv *TableIndex) MutateKeyCount(n uint32) bool {
	return rcv._tab.MutateUint32Slot(10, n)
}
  • Purpose: Mutates the value of the KeyCount field.
  • Parameters:
    • n: The new value for the KeyCount field.
  • Returns: true if the mutation was successful, false otherwise.

UncompressedSize​

func (rcv *TableIndex) UncompressedSize() uint32 {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(12))
	if o != 0 {
		return rcv._tab.GetUint32(o + rcv._tab.Pos)
	}
	return 0
}
  • Purpose: Returns the value of the UncompressedSize field.
  • Parameters: None
  • Returns: The value of the UncompressedSize field.

MutateUncompressedSize​

func (rcv *TableIndex) MutateUncompressedSize(n uint32) bool {
	return rcv._tab.MutateUint32Slot(12, n)
}
  • Purpose: Mutates the value of the UncompressedSize field.
  • Parameters:
    • n: The new value for the UncompressedSize field.
  • Returns: true if the mutation was successful, false otherwise.

OnDiskSize​

func (rcv *TableIndex) OnDiskSize() uint32 {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(14))
	if o != 0 {
		return rcv._tab.GetUint32(o + rcv._tab.Pos)
	}
	return 0
}
  • Purpose: Returns the value of the OnDiskSize field.
  • Parameters: None
  • Returns: The value of the OnDiskSize field.

MutateOnDiskSize​

func (rcv *TableIndex) MutateOnDiskSize(n uint32) bool {
	return rcv._tab.MutateUint32Slot(14, n)
}
  • Purpose: Mutates the value of the OnDiskSize field.
  • Parameters:
    • n: The new value for the OnDiskSize field.
  • Returns: true if the mutation was successful, false otherwise.

StaleDataSize​

func (rcv *TableIndex) StaleDataSize() uint32 {
	o := flatbuffers.UOffsetT(rcv._tab.Offset(16))
	if o != 0 {
		return rcv._tab.GetUint32(o + rcv._tab.Pos)
	}
	return 0
}
  • Purpose: Returns the value of the StaleDataSize field.
  • Parameters: None
  • Returns: The value of the StaleDataSize field.

MutateStaleDataSize​

func (rcv *TableIndex) MutateStaleDataSize(n uint32) bool {
	return rcv._tab.MutateUint32Slot(16, n)
}
  • Purpose: Mutates the value of the StaleDataSize field.
  • Parameters:
    • n: The new value for the StaleDataSize field.
  • Returns: true if the mutation was successful, false otherwise.

TableIndexStart​

func TableIndexStart(builder *flatbuffers.Builder) {
	builder.StartObject(7)
}
  • Purpose: Starts a new TableIndex object in the builder.
  • Parameters:
    • builder: The flatbuffers.Builder object.
  • Returns: None

TableIndexAddOffsets​

func TableIndexAddOffsets(builder *flatbuffers.Builder, offsets flatbuffers.UOffsetT) {
	builder.PrependUOffsetTSlot(0, flatbuffers.UOffsetT(offsets), 0)
}
  • Purpose: Adds the Offsets vector to the TableIndex object.
  • Parameters:
    • builder: The flatbuffers.Builder object.
    • offsets: The offset of the Offsets vector.
  • Returns: None

TableIndexStartOffsetsVector​

func TableIndexStartOffsetsVector(builder *flatbuffers.Builder, numElems int) flatbuffers.UOffsetT {
	return builder.StartVector(4, numElems, 4)
}
  • Purpose: Starts a new Offsets vector in the builder.
  • Parameters:
    • builder: The flatbuffers.Builder object.
    • numElems: The number of elements in the vector.
  • Returns: The offset of the new vector.

TableIndexAddBloomFilter​

func TableIndexAddBloomFilter(builder *flatbuffers.Builder, bloomFilter flatbuffers.UOffsetT) {
	builder.PrependUOffsetTSlot(1, flatbuffers.UOffsetT(bloomFilter), 0)
}
  • Purpose: Adds the BloomFilter vector to the TableIndex object.
  • Parameters:
    • builder: The flatbuffers.Builder object.
    • bloomFilter: The offset of the BloomFilter vector.
  • Returns: None

TableIndexStartBloomFilterVector​

func TableIndexStartBloomFilterVector(builder *flatbuffers.Builder, numElems int) flatbuffers.UOffsetT {
	return builder.StartVector(1, numElems, 1)
}
  • Purpose: Starts a new BloomFilter vector in the builder.
  • Parameters:
    • builder: The flatbuffers.Builder object.
    • numElems: The number of elements in the vector.
  • Returns: The offset of the new vector.

TableIndexAddMaxVersion​

func TableIndexAddMaxVersion(builder *flatbuffers.Builder, maxVersion uint64) {
	builder.PrependUint64Slot(2, maxVersion, 0)
}
  • Purpose: Adds the MaxVersion field to the TableIndex object.
  • Parameters:
    • builder: The flatbuffers.Builder object.
    • maxVersion: The value of the MaxVersion field.
  • Returns: None

TableIndexAddKeyCount​

func TableIndexAddKeyCount(builder *flatbuffers.Builder, keyCount uint32) {
	builder.PrependUint32Slot(3, keyCount, 0)
}
  • Purpose: Adds the KeyCount field to the TableIndex object.
  • Parameters:
    • builder: The flatbuffers.Builder object.
    • keyCount: The value of the KeyCount field.
  • Returns: None

TableIndexAddUncompressedSize​

func TableIndexAddUncompressedSize(builder *flatbuffers.Builder, uncompressedSize uint32) {
	builder.PrependUint32Slot(4, uncompressedSize, 0)
}
  • Purpose: Adds the UncompressedSize field to the TableIndex object.
  • Parameters:
    • builder: The flatbuffers.Builder object.
    • uncompressedSize: The value of the UncompressedSize field.
  • Returns: None

TableIndexAddOnDiskSize​

func TableIndexAddOnDiskSize(builder *flatbuffers.Builder, onDiskSize uint32) {
	builder.PrependUint32Slot(5, onDiskSize, 0)
}
  • Purpose: Adds the OnDiskSize field to the TableIndex object.
  • Parameters:
    • builder: The flatbuffers.Builder object.
    • onDiskSize: The value of the OnDiskSize field.
  • Returns: None

TableIndexAddStaleDataSize​

func TableIndexAddStaleDataSize(builder *flatbuffers.Builder, staleDataSize uint32) {
	builder.PrependUint32Slot(6, staleDataSize, 0)
}
  • Purpose: Adds the StaleDataSize field to the TableIndex object.
  • Parameters:
    • builder: The flatbuffers.Builder object.
    • staleDataSize: The value of the StaleDataSize field.
  • Returns: None

TableIndexEnd​

func TableIndexEnd(builder *flatbuffers.Builder) flatbuffers.UOffsetT {
	return builder.EndObject()
}
  • Purpose: Finishes the creation of a TableIndex object.
  • Parameters:
    • builder: The flatbuffers.Builder object.
  • Returns: The offset of the created TableIndex object.

Code Examples​

None

Getting Started Relevance​