• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1import * as flatbuffers from 'flatbuffers';
2import { KeyValue, KeyValueT } from '../reflection/key-value.js';
3import { Type, TypeT } from '../reflection/type.js';
4export declare class Field implements flatbuffers.IUnpackableObject<FieldT> {
5    bb: flatbuffers.ByteBuffer | null;
6    bb_pos: number;
7    __init(i: number, bb: flatbuffers.ByteBuffer): Field;
8    static getRootAsField(bb: flatbuffers.ByteBuffer, obj?: Field): Field;
9    static getSizePrefixedRootAsField(bb: flatbuffers.ByteBuffer, obj?: Field): Field;
10    name(): string | null;
11    name(optionalEncoding: flatbuffers.Encoding): string | Uint8Array | null;
12    type(obj?: Type): Type | null;
13    id(): number;
14    mutate_id(value: number): boolean;
15    offset(): number;
16    mutate_offset(value: number): boolean;
17    defaultInteger(): bigint;
18    mutate_default_integer(value: bigint): boolean;
19    defaultReal(): number;
20    mutate_default_real(value: number): boolean;
21    deprecated(): boolean;
22    mutate_deprecated(value: boolean): boolean;
23    required(): boolean;
24    mutate_required(value: boolean): boolean;
25    key(): boolean;
26    mutate_key(value: boolean): boolean;
27    attributes(index: number, obj?: KeyValue): KeyValue | null;
28    attributesLength(): number;
29    documentation(index: number): string;
30    documentation(index: number, optionalEncoding: flatbuffers.Encoding): string | Uint8Array;
31    documentationLength(): number;
32    optional(): boolean;
33    mutate_optional(value: boolean): boolean;
34    /**
35     * Number of padding octets to always add after this field. Structs only.
36     */
37    padding(): number;
38    mutate_padding(value: number): boolean;
39    /**
40     * If the field uses 64-bit offsets.
41     */
42    offset64(): boolean;
43    mutate_offset64(value: boolean): boolean;
44    static getFullyQualifiedName(): string;
45    static startField(builder: flatbuffers.Builder): void;
46    static addName(builder: flatbuffers.Builder, nameOffset: flatbuffers.Offset): void;
47    static addType(builder: flatbuffers.Builder, typeOffset: flatbuffers.Offset): void;
48    static addId(builder: flatbuffers.Builder, id: number): void;
49    static addOffset(builder: flatbuffers.Builder, offset: number): void;
50    static addDefaultInteger(builder: flatbuffers.Builder, defaultInteger: bigint): void;
51    static addDefaultReal(builder: flatbuffers.Builder, defaultReal: number): void;
52    static addDeprecated(builder: flatbuffers.Builder, deprecated: boolean): void;
53    static addRequired(builder: flatbuffers.Builder, required: boolean): void;
54    static addKey(builder: flatbuffers.Builder, key: boolean): void;
55    static addAttributes(builder: flatbuffers.Builder, attributesOffset: flatbuffers.Offset): void;
56    static createAttributesVector(builder: flatbuffers.Builder, data: flatbuffers.Offset[]): flatbuffers.Offset;
57    static startAttributesVector(builder: flatbuffers.Builder, numElems: number): void;
58    static addDocumentation(builder: flatbuffers.Builder, documentationOffset: flatbuffers.Offset): void;
59    static createDocumentationVector(builder: flatbuffers.Builder, data: flatbuffers.Offset[]): flatbuffers.Offset;
60    static startDocumentationVector(builder: flatbuffers.Builder, numElems: number): void;
61    static addOptional(builder: flatbuffers.Builder, optional: boolean): void;
62    static addPadding(builder: flatbuffers.Builder, padding: number): void;
63    static addOffset64(builder: flatbuffers.Builder, offset64: boolean): void;
64    static endField(builder: flatbuffers.Builder): flatbuffers.Offset;
65    unpack(): FieldT;
66    unpackTo(_o: FieldT): void;
67}
68export declare class FieldT implements flatbuffers.IGeneratedObject {
69    name: string | Uint8Array | null;
70    type: TypeT | null;
71    id: number;
72    offset: number;
73    defaultInteger: bigint;
74    defaultReal: number;
75    deprecated: boolean;
76    required: boolean;
77    key: boolean;
78    attributes: (KeyValueT)[];
79    documentation: (string)[];
80    optional: boolean;
81    padding: number;
82    offset64: boolean;
83    constructor(name?: string | Uint8Array | null, type?: TypeT | null, id?: number, offset?: number, defaultInteger?: bigint, defaultReal?: number, deprecated?: boolean, required?: boolean, key?: boolean, attributes?: (KeyValueT)[], documentation?: (string)[], optional?: boolean, padding?: number, offset64?: boolean);
84    pack(builder: flatbuffers.Builder): flatbuffers.Offset;
85}
86