ceph/src/arrow/js/src/fb/File.ts

   1 // automatically generated by the FlatBuffers compiler, do not modify
   2
   3 import { flatbuffers } from 'flatbuffers';
   4 import * as NS13596923344997147894 from './Schema';
   5 /**
   6  * ----------------------------------------------------------------------
   7  * Arrow File metadata
   8  *
   9  *
  10  * @constructor
  11  */
  12 export class Footer {
  13     bb: flatbuffers.ByteBuffer | null = null;
  14
  15     bb_pos: number = 0;
  16     /**
  17      * @param number i
  18      * @param flatbuffers.ByteBuffer bb
  19      * @returns Footer
  20      */
  21     __init(i: number, bb: flatbuffers.ByteBuffer): Footer {
  22         this.bb_pos = i;
  23         this.bb = bb;
  24         return this;
  25     }
  26
  27     /**
  28      * @param flatbuffers.ByteBuffer bb
  29      * @param Footer= obj
  30      * @returns Footer
  31      */
  32     static getRootAsFooter(bb: flatbuffers.ByteBuffer, obj?: Footer): Footer {
  33         return (obj || new Footer()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
  34     }
  35
  36     /**
  37      * @param flatbuffers.ByteBuffer bb
  38      * @param Footer= obj
  39      * @returns Footer
  40      */
  41     static getSizePrefixedRootAsFooter(bb: flatbuffers.ByteBuffer, obj?: Footer): Footer {
  42         bb.setPosition(bb.position() + flatbuffers.SIZE_PREFIX_LENGTH);
  43         return (obj || new Footer()).__init(bb.readInt32(bb.position()) + bb.position(), bb);
  44     }
  45
  46     /**
  47      * @returns MetadataVersion
  48      */
  49     version(): NS13596923344997147894.MetadataVersion {
  50         const offset = this.bb!.__offset(this.bb_pos, 4);
  51         return offset ? /**  */ (this.bb!.readInt16(this.bb_pos + offset)) : NS13596923344997147894.MetadataVersion.V1;
  52     }
  53
  54     /**
  55      * @param Schema= obj
  56      * @returns Schema|null
  57      */
  58     schema(obj?: NS13596923344997147894.Schema): NS13596923344997147894.Schema | null {
  59         const offset = this.bb!.__offset(this.bb_pos, 6);
  60         return offset ? (obj || new NS13596923344997147894.Schema()).__init(this.bb!.__indirect(this.bb_pos + offset), this.bb!) : null;
  61     }
  62
  63     /**
  64      * @param number index
  65      * @param Block= obj
  66      * @returns Block
  67      */
  68     dictionaries(index: number, obj?: Block): Block | null {
  69         const offset = this.bb!.__offset(this.bb_pos, 8);
  70         return offset ? (obj || new Block()).__init(this.bb!.__vector(this.bb_pos + offset) + index * 24, this.bb!) : null;
  71     }
  72
  73     /**
  74      * @returns number
  75      */
  76     dictionariesLength(): number {
  77         const offset = this.bb!.__offset(this.bb_pos, 8);
  78         return offset ? this.bb!.__vector_len(this.bb_pos + offset) : 0;
  79     }
  80
  81     /**
  82      * @param number index
  83      * @param Block= obj
  84      * @returns Block
  85      */
  86     recordBatches(index: number, obj?: Block): Block | null {
  87         const offset = this.bb!.__offset(this.bb_pos, 10);
  88         return offset ? (obj || new Block()).__init(this.bb!.__vector(this.bb_pos + offset) + index * 24, this.bb!) : null;
  89     }
  90
  91     /**
  92      * @returns number
  93      */
  94     recordBatchesLength(): number {
  95         const offset = this.bb!.__offset(this.bb_pos, 10);
  96         return offset ? this.bb!.__vector_len(this.bb_pos + offset) : 0;
  97     }
  98
  99     /**
 100      * User-defined metadata
 101      *
 102      * @param number index
 103      * @param KeyValue= obj
 104      * @returns KeyValue
 105      */
 106     customMetadata(index: number, obj?: NS13596923344997147894.KeyValue): NS13596923344997147894.KeyValue | null {
 107         const offset = this.bb!.__offset(this.bb_pos, 12);
 108         return offset ? (obj || new NS13596923344997147894.KeyValue()).__init(this.bb!.__indirect(this.bb!.__vector(this.bb_pos + offset) + index * 4), this.bb!) : null;
 109     }
 110
 111     /**
 112      * @returns number
 113      */
 114     customMetadataLength(): number {
 115         const offset = this.bb!.__offset(this.bb_pos, 12);
 116         return offset ? this.bb!.__vector_len(this.bb_pos + offset) : 0;
 117     }
 118
 119     /**
 120      * @param flatbuffers.Builder builder
 121      */
 122     static startFooter(builder: flatbuffers.Builder) {
 123         builder.startObject(5);
 124     }
 125
 126     /**
 127      * @param flatbuffers.Builder builder
 128      * @param MetadataVersion version
 129      */
 130     static addVersion(builder: flatbuffers.Builder, version: NS13596923344997147894.MetadataVersion) {
 131         builder.addFieldInt16(0, version, NS13596923344997147894.MetadataVersion.V1);
 132     }
 133
 134     /**
 135      * @param flatbuffers.Builder builder
 136      * @param flatbuffers.Offset schemaOffset
 137      */
 138     static addSchema(builder: flatbuffers.Builder, schemaOffset: flatbuffers.Offset) {
 139         builder.addFieldOffset(1, schemaOffset, 0);
 140     }
 141
 142     /**
 143      * @param flatbuffers.Builder builder
 144      * @param flatbuffers.Offset dictionariesOffset
 145      */
 146     static addDictionaries(builder: flatbuffers.Builder, dictionariesOffset: flatbuffers.Offset) {
 147         builder.addFieldOffset(2, dictionariesOffset, 0);
 148     }
 149
 150     /**
 151      * @param flatbuffers.Builder builder
 152      * @param number numElems
 153      */
 154     static startDictionariesVector(builder: flatbuffers.Builder, numElems: number) {
 155         builder.startVector(24, numElems, 8);
 156     }
 157
 158     /**
 159      * @param flatbuffers.Builder builder
 160      * @param flatbuffers.Offset recordBatchesOffset
 161      */
 162     static addRecordBatches(builder: flatbuffers.Builder, recordBatchesOffset: flatbuffers.Offset) {
 163         builder.addFieldOffset(3, recordBatchesOffset, 0);
 164     }
 165
 166     /**
 167      * @param flatbuffers.Builder builder
 168      * @param number numElems
 169      */
 170     static startRecordBatchesVector(builder: flatbuffers.Builder, numElems: number) {
 171         builder.startVector(24, numElems, 8);
 172     }
 173
 174     /**
 175      * @param flatbuffers.Builder builder
 176      * @param flatbuffers.Offset customMetadataOffset
 177      */
 178     static addCustomMetadata(builder: flatbuffers.Builder, customMetadataOffset: flatbuffers.Offset) {
 179         builder.addFieldOffset(4, customMetadataOffset, 0);
 180     }
 181
 182     /**
 183      * @param flatbuffers.Builder builder
 184      * @param Array.<flatbuffers.Offset> data
 185      * @returns flatbuffers.Offset
 186      */
 187     static createCustomMetadataVector(builder: flatbuffers.Builder, data: flatbuffers.Offset[]): flatbuffers.Offset {
 188         builder.startVector(4, data.length, 4);
 189         for (let i = data.length - 1; i >= 0; i--) {
 190             builder.addOffset(data[i]);
 191         }
 192         return builder.endVector();
 193     }
 194
 195     /**
 196      * @param flatbuffers.Builder builder
 197      * @param number numElems
 198      */
 199     static startCustomMetadataVector(builder: flatbuffers.Builder, numElems: number) {
 200         builder.startVector(4, numElems, 4);
 201     }
 202
 203     /**
 204      * @param flatbuffers.Builder builder
 205      * @returns flatbuffers.Offset
 206      */
 207     static endFooter(builder: flatbuffers.Builder): flatbuffers.Offset {
 208         const offset = builder.endObject();
 209         return offset;
 210     }
 211
 212     /**
 213      * @param flatbuffers.Builder builder
 214      * @param flatbuffers.Offset offset
 215      */
 216     static finishFooterBuffer(builder: flatbuffers.Builder, offset: flatbuffers.Offset) {
 217         builder.finish(offset);
 218     }
 219
 220     /**
 221      * @param flatbuffers.Builder builder
 222      * @param flatbuffers.Offset offset
 223      */
 224     static finishSizePrefixedFooterBuffer(builder: flatbuffers.Builder, offset: flatbuffers.Offset) {
 225         builder.finish(offset, undefined, true);
 226     }
 227
 228     static createFooter(builder: flatbuffers.Builder, version: NS13596923344997147894.MetadataVersion, schemaOffset: flatbuffers.Offset, dictionariesOffset: flatbuffers.Offset, recordBatchesOffset: flatbuffers.Offset, customMetadataOffset: flatbuffers.Offset): flatbuffers.Offset {
 229         Footer.startFooter(builder);
 230         Footer.addVersion(builder, version);
 231         Footer.addSchema(builder, schemaOffset);
 232         Footer.addDictionaries(builder, dictionariesOffset);
 233         Footer.addRecordBatches(builder, recordBatchesOffset);
 234         Footer.addCustomMetadata(builder, customMetadataOffset);
 235         return Footer.endFooter(builder);
 236     }
 237 }
 238 /**
 239  * @constructor
 240  */
 241 export class Block {
 242     bb: flatbuffers.ByteBuffer | null = null;
 243
 244     bb_pos: number = 0;
 245     /**
 246      * @param number i
 247      * @param flatbuffers.ByteBuffer bb
 248      * @returns Block
 249      */
 250     __init(i: number, bb: flatbuffers.ByteBuffer): Block {
 251         this.bb_pos = i;
 252         this.bb = bb;
 253         return this;
 254     }
 255
 256     /**
 257      * Index to the start of the RecordBlock (note this is past the Message header)
 258      *
 259      * @returns flatbuffers.Long
 260      */
 261     offset(): flatbuffers.Long {
 262         return this.bb!.readInt64(this.bb_pos);
 263     }
 264
 265     /**
 266      * Length of the metadata
 267      *
 268      * @returns number
 269      */
 270     metaDataLength(): number {
 271         return this.bb!.readInt32(this.bb_pos + 8);
 272     }
 273
 274     /**
 275      * Length of the data (this is aligned so there can be a gap between this and
 276      * the metadata).
 277      *
 278      * @returns flatbuffers.Long
 279      */
 280     bodyLength(): flatbuffers.Long {
 281         return this.bb!.readInt64(this.bb_pos + 16);
 282     }
 283
 284     /**
 285      * @param flatbuffers.Builder builder
 286      * @param flatbuffers.Long offset
 287      * @param number metaDataLength
 288      * @param flatbuffers.Long bodyLength
 289      * @returns flatbuffers.Offset
 290      */
 291     static createBlock(builder: flatbuffers.Builder, offset: flatbuffers.Long, metaDataLength: number, bodyLength: flatbuffers.Long): flatbuffers.Offset {
 292         builder.prep(8, 24);
 293         builder.writeInt64(bodyLength);
 294         builder.pad(4);
 295         builder.writeInt32(metaDataLength);
 296         builder.writeInt64(offset);
 297         return builder.offset();
 298     }
 299
 300 }